Update harness coding documentation templates

This commit is contained in:
QiuSW
2026-06-24 17:07:53 +08:00
parent d6c0e5b612
commit 2b4a842d7a
13 changed files with 189 additions and 79 deletions
+4 -3
View File
@@ -25,9 +25,9 @@ Get-ChildItem -Recurse -File
| ID | 任务 | 依赖 | 验收要点 | 状态 |
| --- | --- | --- | --- | --- |
| H-001 | 建立 Codex 入口 `AGENTS.md` | - | 说明仓库定位、必读顺序、工作规则和验证方式 | DONE |
| H-002 | 建立 Claude Code 入口 `CLAUDE.md` | - | 说明 Claude Code 读取顺序、模板边界和禁止事项 | DONE |
| H-002 | 建立 Claude Code 入口 `CLAUDE.md` | - | 作为薄入口指向 `AGENTS.md`,不重复维护规则和文档清单 | DONE |
| H-003 | 建立根目录总览 `README.md` | - | 说明样本库用途、推荐文档集合和使用方式 | DONE |
| H-004 | 明确 `docs/` 是 harness coding 文档目录 | H-001, H-002 | `AGENTS.md` 和 `CLAUDE.md` 均说明编程从 `docs/00-ai-start-here.md` 进入 | DONE |
| H-004 | 明确 `docs/` 是 harness coding 文档目录 | H-001, H-002 | `AGENTS.md` 说明编程从 `docs/00-ai-start-here.md` 进入,`CLAUDE.md` 指向 `AGENTS.md` | DONE |
| H-005 | 建立样本库任务列表 `tasks.md` | H-001 | 根目录存在维护任务列表,并和 `docs/06-tasks.md` 职责区分清楚 | DONE |
## Phase 1 · 核心模板
@@ -50,12 +50,13 @@ Get-ChildItem -Recurse -File
| H-201 | 建立 API 合约模板 `docs/api.md` | H-106 | 能记录接口形状、错误格式、鉴权和示例 | DONE |
| H-202 | 建立路由模板 `docs/routes.md` | H-106 | 能记录页面路由、组件归属和导航规则 | DONE |
| H-203 | 建立当前状态模板 `docs/current-state.md` | H-108 | 能记录仓库现实、已完成内容、可运行命令和下一步 | DONE |
| H-204 | 建立执行进度模板 `progress.md` | H-108 | 能追加记录任务执行、验证命令、阻塞点和关键决策 | DONE |
## Phase 3 · 一致性维护
| ID | 任务 | 依赖 | 验收要点 | 状态 |
| --- | --- | --- | --- | --- |
| H-301 | 检查入口文件之间的职责是否重复 | H-005 | `AGENTS.md`、`CLAUDE.md`、`README.md`、`docs/README.md`、`docs/00-ai-start-here.md` 各自职责清楚 | TODO |
| H-301 | 检查入口文件之间的职责是否重复 | H-005 | `AGENTS.md`、`CLAUDE.md`、`README.md`、`docs/README.md`、`docs/00-ai-start-here.md`、`progress.md` 各自职责清楚 | TODO |
| H-302 | 检查所有模板是否保持通用占位符 | H-201, H-202, H-203 | 没有混入只适用于某个真实项目的业务事实 | TODO |
| H-303 | 检查链接和文件名引用一致性 | H-301 | `rg` 搜索无旧名称、坏路径或冲突说明 | TODO |
| H-304 | 补充复制到新项目后的使用流程 | H-302 | README 和入口模板能指导用户从复制、替换占位符到开始编程 | TODO |