doc-consistency-reviewer

Documentation Consistency Reviewer

Objective

Systematically identify all descriptions in README + docs/ that are "outdated" or "inconsistent with the implementation", and output ≥30 issue items.

Core Principles

1. Code is the source of truth - When documentation and code conflict, source code/configuration/contract files prevail
2. Conclude only with evidence - Each issue must cite the code/configuration location as its basis
3. Contract first - OpenAPI/proto/schema/TS types are regarded as the SSOT
4. Tighten secure defaults - Security-related inconsistencies are prioritized and marked as high severity

Review Process

1. Documentation Enumeration

# 扫描范围
- README.md (根目录)
- docs/**/*.md (所有文档)
- 合同文件: OpenAPI/proto/GraphQL schema/TS types

2. Document-by-Document Review

For each document:

1. List key claims/commitments/configurations/interface items
2. Search the code for the corresponding implementation
3. Compare differences: missing/renamed/inconsistent behavior/inconsistent default values
4. Record issue items according to the template

3. Horizontal Cross-Check

• Check documentation in reverse from contract files
• Check documentation in reverse from configuration files

For the detailed checklist, see references/checklist.md

Severity Levels

Level	Definition	Example
P0	Security issue/seriously misleading	Documentation states the sandbox is enabled but the code does not enable it
P1	Core functionality inconsistent	Following the documentation will fail
P2	Incomplete example/inconsistent naming	Does not directly block usage
P3	Minor wording/format/link issues	Does not affect functionality
Pending evidence supplementation	Suspicion but insufficient evidence	Requires further investigation

Output Format

For the detailed template, see references/output-format.md

Single Issue Item

### [标题]
- **严重级别**: P0/P1/P2/P3/待证据补充
- **位置**: `<文件路径>:<行号>`
- **证据**:
  - 文档: [引用]
  - 代码: [引用]
- **影响**: [误导后果]
- **建议**: [最小修正]
- **关联原则**: 以代码为真/合同优先/安全默认收紧/...

Review Conclusion

## 审核结论
- **结论**: 通过/有条件通过/不通过
- **汇总**: P0:x P1:x P2:x P3:x 待补充:x
- **修复优先级**: P0 → P1 → P2 → P3

Multi-Agent Parallelism

If acceleration is needed, it can be split among multiple agents for parallel execution along the following dimensions:

1. Split by document type - One agent each for README, API documentation, and development guide
2. Split by module - One agent each for the documentation of different functional modules
3. Split by check direction - One checks code from documentation, one checks documentation from code

During aggregation, deduplication and unification of severity levels are required.

Execution

After the review is complete, output the doc-consistency.md report file.