Skip to content

/docaudit

文档体系审计。检查文档完整性、索引一致性和规范合规性。

文档体系审计

步骤

  1. 索引一致性检查

    • 读取 docs/design/README.md 索引表
    • 扫描 docs/design/ 目录下所有 *.md 文件(排除 README.md 和 CHANGELOG.md)
    • 比对:索引中列出但文件不存在的条目 → 报错
    • 比对:文件存在但索引中未列出的条目 → 报错
  2. 编号连续性检查

    • 提取所有文档的编号前缀(00, 01, 02...)
    • 检查是否有跳号或重号
  3. CHANGELOG 时效性检查

    • 读取 docs/design/CHANGELOG.md
    • 检查最新条目的日期是否为最近 7 天内
    • 如果最近有 git 提交修改了 docs/design/ 下的文件,但 CHANGELOG 未更新 → 警告
  4. 文档行数检查

    • 统计每篇文档的行数
    • 超过 500 行的文档 → 警告,建议拆分
  5. 交叉引用检查

    • 扫描文档中的内部链接([xxx](./yy-zzz.md)
    • 检查链接目标是否存在
  6. 知识沉淀检查(如目录存在)

    • docs/research/docs/troubleshooting/ 下的文件是否都在对应 README.md 索引中
    • 文件 frontmatter 是否包含 titledatetags 三个必填字段

    参考 doc-22 项目知识沉淀机制 §6

输出格式

## 文档审计报告

### 通过 ✓
- [列出通过的检查项]

### 警告 ⚠
- [列出警告项,附具体位置和建议]

### 错误 ✗
- [列出必须修复的问题]

### 统计
- 文档总数:N 篇
- 总行数:N 行
- 平均行数:N 行/篇
- 最长文档:xx-xxx.md(N 行)

IMPORTANT:客观报告,不美化。有问题就直说,没有问题就确认通过。

面向个人开发者的 AI 辅助编程工程化方案