用途:把文档当作质量系统来审计——先发现应存在的内容,再映射已有内容,按风险排序缺口,并加入检查以防关键文档退化。它补充 docs-codebase(后者更适合撰写或重构你决定修复的文档)。
主要能力:发现与审计流程、优先级与度量、AI 指令与 llms.txt 及时效性检查、运行手册与契约验证、CI/CD 门禁;附带脚本与模板,如 check_local_links.py、check_external_links.py、docs_freshness_report.py、coverage-report-template.md、documentation-backlog-template.md。
使用方式:先发现服务、契约、运行手册、指令文件与关键工作流;将现有文档映射到审计模型,识别真实缺口、重复与陈旧区域(排除归档);按严重度排序;用脚本或 CI 验证链接、运行手册、契约与时效信号,并标注证据等级(清单、静态、已执行、操作员验证)。默认时效阈值:P1 为 30 天且阻断,运行 docs_freshness_report.py --fail-on P1;P2 为 60 天警告;P3 为 90 天警告。非阻断债务记入待办。
适用场景:检查文档覆盖率、时效性、运行手册有效性、AI 指令覆盖,清理陈旧或重复文档,以及为关键外部契约和运行手册设置 CI 门禁。
限制:覆盖率百分比只是筛查信号而非结论,需抽样核查实际内容;AI 生成的文档在链接、命令与声明被检查前应视为草稿;不要为自明代码或即将废弃组件推荐文档;命名负责人但无强制机制是最弱的归属模型,应标记为缺口。其他细节暂未提供。