3.5 KiB
3.5 KiB
改进计划（基于评审意见，排除 CLAUDE-BOOTSTRAP.md 相关问题）
计划日期: 2026-02-03
适用范围: README、QUICK_REFERENCE、WORKFLOWS、WEEKLY_REVIEW、package.json、06_Metadata 模板与附件管理文档
目标: 统一入口与命令规范，明确工具调用方式，强化文档主线导航与可追溯性。
阶段 0：基线校准（1 天）
目标: 修正评审报告中的硬性数据与证据链。
- 更新
06_Metadata/REVIEW_REPORT_2026-02-03.md的“索引概况”为实际值（当前索引为 639 个 Markdown 文档）。 - 在“关键问题与风险”每条后追加“证据”行（文件路径 + 简短说明）。
- 在“结论”中注明评审日期与索引日期一致。
验收标准:
- 报告中所有关键问题具备可追溯证据。
阶段 1：入口统一（1-2 天）
目标: 明确权威入口，消除“并行主线”的认知冲突。
- 在
README.md增加“权威入口”段落，明确：README.md= 项目入口与导航QUICK_REFERENCE.md= 速查06_Metadata/WORKFLOWS.md= 详细工作流
- 在
QUICK_REFERENCE.md顶部增加“入口说明 + 返回导航”。 - 在
06_Metadata/WORKFLOWS.md顶部增加“与 README/Quick Reference 的关系说明”。
验收标准:
- 三者之间互相可达，且入口职责清晰一致。
阶段 2：命令规范一致性（2-3 天）
目标: 统一文档命令示例与脚本规则的边界。
- 明确规则（选其一并写入文档）：
- 方案 A：文档示例不使用管道、grep、find 等；脚本亦保持简化。
- 方案 B：脚本允许复杂命令，文档中的“手动命令”禁止复杂命令，并明确例外。
- 同步修订
WEEKLY_REVIEW.md的示例命令，使其与规则一致。 - 对
package.json脚本在 README 或 WORKFLOWS 增加说明，避免规则冲突。
验收标准:
- 文档中的命令示例与规则完全一致。
- 不再出现“禁止管道但示例有管道”的矛盾。
阶段 3：工具调用统一（1 天）
目标: 统一 pnpm/npm 的使用方式。
- 统一所有文档的脚本调用为
pnpm。 - 若保留兼容说明：增加一段“未安装 pnpm 可用 npm run”的规范化说明。
- 修订 README 中出现的
npm run示例，保持一致。
验收标准:
- 文档中的脚本调用方式保持一致。
阶段 4：文档主线导航（1 天）
目标: 提供清晰的阅读与执行路径。
- 在
README.md增加“新用户路径”和“维护者路径”。 - 在
QUICK_REFERENCE.md增加“常用路径导航”。
验收标准:
- 新用户可以在 2-3 次跳转内找到完整工作流说明。
阶段 5：复审与维护（0.5-1 天）
目标: 验证改动有效、评分依据可复用。
- 对 README、QUICK_REFERENCE、WORKFLOWS、WEEKLY_REVIEW、package.json 做一次一致性复查。
- 更新评审报告评分依据（补充评分标准或示例）。
验收标准:
- 评审报告可被他人复核。
执行顺序建议
- 阶段 0（校准）
- 阶段 1（入口）
- 阶段 2（命令规范）
- 阶段 3（工具统一）
- 阶段 4（导航）
- 阶段 5（复审）
产出文件清单
06_Metadata/IMPROVEMENT_PLAN_2026-02-03.md（本计划）- 更新：
06_Metadata/REVIEW_REPORT_2026-02-03.md - 更新：
README.md - 更新：
QUICK_REFERENCE.md - 更新：
06_Metadata/WORKFLOWS.md - 更新：
WEEKLY_REVIEW.md