模板:复制即可开工¶
这些模板不是“给你看看”,而是每个阶段真正要落到仓库里的文件。建议整套拷进新项目,再按团队习惯微调。
文档类模板¶
| 模板 | 用途 | 对应阶段 |
|---|---|---|
| spec.md | 功能规格说明书:目标、范围、规则、边界 | ① 需求调研 |
| user-story-details.md | 每个用户故事的 UI、API、数据、规则、验收用例 | ① 需求调研 |
| tech-design.md | 技术设计总文档:架构、技术栈、契约、风险 | ⑥ 技术设计 |
| CLAUDE.md | 项目级 AI 工作约定,每次会话自动加载 | 全程 |
| agent-brief.md | 子 Agent 任务书:目标、边界、输入输出、完成标准 | ⑦ AI 编码 |
| feature-implementation.md | 功能实现细节(施工图):模块、文件、事务、测试 | ⑥⑦ 设计到编码 |
| feature-report.md | 单个功能的实现报告:改动、测试、证据、遗留问题 | ⑦ AI 编码 |
| qa-checklist.md | G6 验收门禁检查清单 | ⑧ 质量保证 |
| deploy-checklist.md | G7 发布门禁检查清单,生产发布需签字 | ⑨ 部署发布 |
数据与工具文件¶
| 文件 | 用途 |
|---|---|
| user-story.csv | 用户故事总表,唯一状态源(下载后使用) |
| e2e-manifest.json | E2E 步骤清单,驱动 Chrome MCP 测试和 Word 报告 |
| Makefile | 一键 lint / test / e2e / report 的入口 |
怎么用¶
- 新建项目后,把整套模板拷到对应目录(推荐结构见完整导读)。
- 先填
spec.md和user-story.csv,再写user-story-details.md。 - 契约冻结后,用
agent-brief.md给每个 Agent 派活,用feature-report.md收活。 - 状态只通过脚本更新,不要手改 CSV。
一个功能一个文件
实现细节、实现报告、E2E manifest 都按功能拆分,不要多个功能混在一个文件里。这样 Agent 的上下文干净,出问题也容易定位。