docaudit.md

来自 cli/templates/level-3/

---
name: docaudit
description: >
  文档体系审计。检查文档完整性、索引一致性和规范合规性。
  当新增/修改/删除文档后使用，确保索引、CHANGELOG 和规范得到遵守。
---

# 文档体系审计

## 步骤

1. **索引一致性检查**
   - 读取项目的文档索引文件（如 README.md 或 docs/ 下的索引）
   - 扫描文档目录下所有 .md 文件
   - 比对：索引中列出但文件不存在的条目 → 报错
   - 比对：文件存在但索引中未列出的条目 → 报错

2. **编号连续性检查**
   - 提取所有文档的编号前缀（00, 01, 02...）
   - 检查是否有跳号或重号

3. **CHANGELOG 时效性检查**
   - 读取 CHANGELOG.md
   - 检查最新条目的日期是否为最近 7 天内
   - 如果最近有 git 提交修改了文档目录下的文件，但 CHANGELOG 未更新 → 警告

4. **文档行数检查**
   - 统计每篇文档的行数
   - 超过 500 行的文档 → 警告，建议拆分

5. **交叉引用检查**
   - 扫描文档中的内部链接
   - 检查链接目标是否存在

## 输出格式

文档审计报告

通过

• [列出通过的检查项]

警告

• [列出警告项，附具体位置和建议]

错误

• [列出必须修复的问题]

统计

• 文档总数：N 篇
• 总行数：N 行
• 平均行数：N 行/篇
• 最长文档：[文件名]（N 行）

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