Documentation
README
Audit Document Skill
适用范围
审查目标为通用文档(README、架构文档、开发指南,不属于规范/技术方案/需求/报告)时,叠加本 Skill(在 G1~G5 之后)。
用户侧文档、最终用户手册、站点文档、项目文档、菜单导航或文档 IA review 场景应优先使用 audit-user-manual 作为聚合入口;本 Skill 仍负责其中的通用文档审查维度。README / 主入口文档场景在本 Skill 基础上,还应叠加 audit-readme。
维度总览(DA-1~DA-6)
| 分组 | 维度 | 优先级 |
|---|---|---|
| A — 内容质量 | DA-1 结构完整性 · DA-2 内容准确性 | 🔴 |
| B — 引用与术语 | DA-3 引用有效性 · DA-4 术语一致性 | 🔴/🟡 |
| C — 受众与关联 | DA-5 受众适配 · DA-6 关联一致性 | 💡/🔴 |
核心检查维度
DA-1 结构完整性 🔴
- 有目录/大纲且与实际章节一致(无多余/遗漏)
- 章节间有逻辑连贯性(无突兀断层)
- 无未完成章节(标题存在但内容为空/"TBD")
- 标题层级合理(H1 唯一,逐级递进,无跳级)
DA-2 内容准确性 🔴
- 版本号/路径/技术栈与实际项目状态一致
- 代码示例可执行(语法正确,命令可运行)
- API/配置说明与代码实现匹配
DA-3 引用有效性 🔴
- 内部链接(相对路径)目标文件存在
- 外部链接可访问(不 404)
- 代码引用的文件/函数/类型存在
DA-4 术语一致性 🟡
- 同一概念在文档内用统一术语(不混用别名)
- 术语与项目 profile 定义一致
This is the opening of the README. Read the full README on GitHub.