中文 —
docs-analysis官方中文版本。
文档需求分析 (中文)
分析所有概念与需求文档,针对当前代码检查其需求,并生成整合的差异报告。
概述与目的
分析 ../docs/ 文件夹中的所有概念与需求文档,针对当前代码检查其需求,并生成整合的差异报告。
命名规范
前缀与后缀
所有经分析的文档将包含:
- 前缀:
conN_,其中 N = 分析版本(1, 2, 3, ...) - 后缀:
_XX,其中 XX = 完成百分比(四舍五入至最接近的 10)
归档阈值
- >= 75% 已完成: 文档将被移动至
../docs/_archive/ - < 75% 已完成: 文档保留在
../docs/中并带有前缀/后缀 - 阈值可配置(默认值:75)
流程
阶段 1:收集文档
- 列出 ../docs/(根目录)中的所有 *.md 和 *.txt 文件
- 过滤掉 README.txt
阶段 2:提取需求
针对每个文档:
- 读取内容
- 识别需求(检查清单、表格、MISSING/TODO 标记)
- 分类:Structure、Code、API、DB Schema、CLI、Feature
阶段 3:代码验证
针对各项需求:
- 确定验证方法(Glob、Grep、Read)
- 执行验证
- 标记为:FULFILLED、PARTIAL、MISSING
阶段 4:评估
- 统计已完成与未完成的需求
- 计算完成百分比 (%)
- 决定:归档 (>= 75%) 或保留 (< 75%)
阶段 5:生成输出
- 创建 REQUIREMENTS_ANALYSIS.md(摘要)
- 创建 consense_diff.md(仅未完成需求,按优先级排列)
阶段 6:版本控制
- 扫描最高 conN_ 前缀
- 新版本 = 最高版本 + 1
阶段 7:重命名与移动
- 对文档应用新的前缀/后缀
- 归档或保留
输出
| 文件 | 描述 |
|---|---|
conN_REQUIREMENTS_ANALYSIS.md |
完整分析(版本 N) |
consense_diff_N.md |
整合的未完成需求 |
_archive/conN_*_XX.* |
已归档 (>=75%) 的文档 |
优先级分类
| 优先级 | 判定标准 |
|---|---|
| P1 | 核心功能缺失,系统无法使用 |
| P2 | 重要特性缺失,但存在变通方案 |
| P3 | 锦上添花,改善用户体验 (UX) |
| P4 | 外观细节、文档、代码质量 |
变更日志
1.0.0 (2026-03-15)
- 从 BACH v3.8.0 移植
从 BACH v3.8.0 移植 | 独立版本