用途:在 harness-step1-create-agents-md 建好 docs/ 骨架后,通过深度阅读项目代码,把隐藏的业务能力、用户流程、架构知识、命名约定、技术决策显式写入 docs/ 各文件,让 agent 在任意 session 快速理解项目全貌。核心原则是推断内容标注来源,无法确定处标「待补充」,不用模糊占位符。
主要能力:按七个步骤产出文档。Step 1 深度扫描:确认 docs/ 存在,用 find 查看三层目录结构,读入口文件、模块边界、依赖声明(package.json / pyproject.toml / go.mod / Cargo.toml)与已有 README、AGENTS.md。Step 2 写 docs/business-solution.md,业务能力须有页面、路由、API、service、测试或正式文档证据,区分已验证、部分验证、待补充。Step 3 写 docs/ARCHITECTURE.md,描述模块划分、依赖方向与数据流,断言组件关系前须用 grep 验证 import。Step 4 写 docs/CONVENTIONS.md,归纳文件与命名规律并附代码实例。Step 5 写 docs/TECH_DECISIONS.md,记录主要框架库的用途、选择原因与替代方案。Step 6 写 docs/QUALITY.md,定义完成的定义与代码审查清单。Step 7 写 docs/exec-plans/tech-debt-tracker.md,记录扫描发现的技术债务。
使用方式:当用户说「填充文档内容」「完善 docs/」时触发;按步骤执行扫描命令并逐文件写入,完成后输出摘要,含已写入内容、业务解决方案摘要与待补充清单。
适用场景:已有代码但文档缺失、需要为 AI agent 建立项目知识库的仓库。
限制:不承诺无法从代码或文档确认的性能、准确率、合规等级与 SLA;不发明项目里没有的约定;无法推断的选型原因标「待补充」;后续可运行 harness-step3-session-management 建立跨 session 状态管理。