| name | nop-doc-audit |
| description | 文档审计工作流 — 交叉验证docs文档与实际代码的一致性,修复不准确的引用和描述。触发词:文档审查、doc audit、核查文档、文档准确性。 |
文档审计工作流
交叉验证 docs-for-ai/ 文档与实际代码的一致性,修复不准确、过时或缺失的内容。
什么时候用我
审查文档 / doc audit / 核查文档 — 验证文档准确性
文档引用检查 — 验证文档中的代码引用是否存在
文档一致性 — 检查多处文档是否描述一致
AUDIT MODE
核心原则
- 文档是 source of truth —
docs-for-ai/ 是规范性文档
- 代码是验证依据 — 文档必须与代码实际行为一致
- 缺失的要删除 — 文档中描述但代码中不存在的内容,删除而非注释
- 不一致的要修复 — 多处文档描述不一致时,以代码实际行为为准
标准流程
Phase 1: 范围确定
MODULE="nop-auth"
DOC="docs-for-ai/02-core-guides/service-layer.md"
Phase 2: 代码引用验证
CLASS_NAME="OrmEntityModelInitializer"
find . -name "*.java" | xargs grep -l "class $CLASS_NAME" 2>/dev/null
METHOD_NAME="addInternalProps"
find . -name "*.java" | xargs grep -l "$METHOD_NAME" 2>/dev/null
test -f "nop-orm-model/src/main/resources/_vfs/nop/orm/imp/orm.imp.xml" && echo "EXISTS" || echo "MISSING"
Phase 3: 行为一致性验证
grep -rn "nop.ai.timeout" --include="*.java" --include="*.xml" .
grep -n "public.*authenticate" nop-auth/service/src/main/java/**/*.java
Phase 4: 交叉文档验证
grep -rn '\[.*\](.*\.md)' docs-for-ai/ | while read line; do
done
Phase 5: 修复
根据审计结果,按优先级修复:
- High - 删除代码中不存在的描述
- Medium - 修复与代码行为不一致的描述
- Low - 补充缺失但重要的信息
常见审计场景
ORM 模型文档审计
grep -rn "entity.*name=" docs-for-ai/ | head -10
find . -name "*.orm.xml" | head -5
API 文档审计
配置文档审计
审计报告格式
# 文档审计报告 - [模块名]
## 审计范围
- 文档: `docs-for-ai/xxx.md`
- 代码: `nop-xxx/`
## 发现问题
### High - 不存在的描述
| 位置 | 问题 | 建议 |
|------|------|------|
| line 42 | 声称存在 `FooBar` 类,但代码中不存在 | 删除该段落 |
### Medium - 行为不一致
| 位置 | 文档描述 | 实际行为 | 建议 |
|------|---------|---------|------|
| line 78 | 返回 `List<String>` | 返回 `List<Integer>` | 更新文档 |
### Low - 缺失信息
| 位置 | 缺失内容 | 重要性 | 建议 |
|------|---------|--------|------|
| line 100 | 未说明异常处理 | 中 | 补充说明 |
## 修复建议
1. ...
2. ...
工具辅助
项目中已有的文档检查工具:
node ai-dev/tools/check-doc-links.mjs --strict
node ai-dev/tools/check-doc-index.mjs
node ai-dev/tools/check-docs-garbled.mjs
node ai-dev/tools/check-oversized-files.mjs
node ai-dev/tools/check-orm-icons.mjs
反模式
- 不要只读文档不读代码 — 必须交叉验证
- 不要保留不存在的描述 — 删除而非注释
- 不要假设文档正确 — 文档可能过时
- 不要一次性审计太多 — 分模块逐步进行
最终检查清单