跳到主要内容

Obsidian格式优化检查清单

date: 2026-01-17

  • 检查清单
  • 文档规范
  • Obsidian aliases:
  • 格式检查清单
  • Obsidian检查清单 cssclasses:
  • checklist category: 检查清单 type: 工具文档 status: 已完成 maintainer: 枫色游侠 rating: 5

Obsidian格式优化检查清单

📋 文档属性面板检查​

✅ Frontmatter 完整性​

  • 包含 title 属性
  • 包含 date 属性（YYYY-MM-DD格式）
  • 包含 tags 标签（至少包含系统分类）
  • 包含 aliases 别名（中英文）
  • 包含 cssclasses 样式类
  • 包含 category 分类
  • 包含 type 文档类型
  • 包含 status 完成状态
  • 包含 maintainer 维护者（枫色游侠）
  • 包含 rating 评分（1-5）

✅ 标签规范​

  • 使用中文标签
  • 标签层级清晰（如：#电气系统/核心设备）
  • 避免特殊字符
  • 保持标签一致性

📝 内容格式检查​

✅ 标题结构​

  • 使用标准标题层级（# ## ###）
  • 每个主标题下有内容
  • 避免跳级使用标题

✅ Callout 使用​

  • 重要信息使用 callout 突出
  • 使用合适的 callout 类型（note, tip, warning, important）
  • Callout 内容简洁明了

✅ 文本格式​

  • 使用中文标点符号
  • 重要术语使用高亮（==术语==）
  • 避免过度使用格式

🔗 链接和嵌入检查​

✅ 双向链接​

  • 使用 [文档名](./文档名.md) 格式
  • 链接文档名准确无误
  • 相关文档都有链接

✅ 嵌入功能​

  • 图片使用 ![图片名](./图片名.md)
  • 可嵌入相关段落
  • 嵌入内容显示正常

📊 图表和表格检查​

✅ Mermaid 图表​

  • 系统架构图清晰
  • 流程图逻辑正确
  • 图表有适当的样式定义

✅ 表格格式​

  • 表格对齐整齐
  • 表头明确
  • 数据准确无误

📖 文档结构检查​

✅ 标准章节（产品文档）​

  • 概述
  • 技术特点
  • 主要品牌厂家
  • 行业规范标准
  • 选型指南
  • 安装调试
  • 运维维护
  • 工程案例
  • 技术参数规格
  • 发展趋势分析
  • 相关技术链接

✅ 内容完整性​

  • 每个章节都有实质性内容
  • 技术参数有单位和说明
  • 案例有具体数据

🔍 质量检查​

✅ 语言规范​

  • 语句通顺，无语法错误
  • 术语使用准确
  • 描述客观中立

✅ 技术准确性​

  • 技术参数正确
  • 标准引用最新版本
  • 品牌信息客观

📈 优化建议​

高优先级​

  1. 添加属性面板 - 所有文档必须有完整的 frontmatter
  2. 标准化章节 - 确保所有产品文档包含11个标准章节
  3. 添加 Callout - 重要信息使用 callout 突出显示
  4. 统一维护者 - 所有文档维护者设置为"枫色游侠"

中优先级​

  1. 完善系统架构图 - 每个产品都应有 Mermaid 架构图
  2. 优化双向链接 - 确保相关产品都有链接
  3. 统一术语 - 保持术语使用一致性

低优先级​

  1. 美化格式 - 优化视觉效果
  2. 添加更多细节 - 丰富内容深度
  3. 增加互动元素 - 添加折叠内容等

🛠️ 批量操作指南​

使用批量更新脚本​

# 给脚本执行权限
chmod +x scripts/update-maintainer.sh

# 运行脚本
./scripts/update-maintainer.sh

手动检查清单​

  1. 随机抽取10%文档进行质量检查
  2. 重点检查新增文档格式
  3. 定期更新过时内容

📝 改进记录​

日期改进内容负责人状态
2026-01-17创建检查清单枫色游侠完成
2026-01-17添加维护者字段枫色游侠完成

最后更新：2026-01-17 版本：v1.0 维护者：枫色游侠