chengmaandClaude Fable 5
795a852aa9
- docs/tasks/README.md: default mode for single and multi agent, drop switch narrative - docs/06-tasks.md: demote to read-only roadmap (phases, milestones, backlog, suggested split list without status) - progress.md: optional archive / project-level event log; execution records live in task files - current-state.md: project-level snapshot; task status authoritative in task frontmatter - sync all referencing docs (start-here, coding-rules, READMEs, adoption/clean-state checklists, method-map, evaluator-rubric) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
77 lines
5.1 KiB
Markdown
77 lines
5.1 KiB
Markdown
# Harness Coding 文档样本库
|
||
|
||
本仓库用于沉淀一个新项目交给 AI coding agent 开发前，建议准备的文档集合。
|
||
|
||
这些文档参考了 `D:\opc_project\lingo\docs` 的实际项目文档结构，抽象为可复用模板：从项目入口、愿景、需求、技术栈、架构、编码规则，到任务路线图、任务文件、API、路由和当前状态。
|
||
|
||
## 推荐文档集合
|
||
|
||
| 文档 | 作用 |
|
||
| --- | --- |
|
||
| [`AGENTS.md`](AGENTS.md) | Codex / 通用 AI coding agent 的仓库级入口 |
|
||
| [`CLAUDE.md`](CLAUDE.md) | Claude Code 的仓库级薄入口 |
|
||
| [`tasks.md`](tasks.md) | 本样本库自身的维护任务列表 |
|
||
| [`init.sh`](init.sh) | 标准启动与验证入口脚本（Unix shell / WSL / Git Bash），统一安装 + 验证 + 打印启动命令 |
|
||
| [`init.ps1`](init.ps1) | 标准启动与验证入口脚本（Windows 原生 PowerShell），与 `init.sh` 等价，按操作系统二选一 |
|
||
| [`progress.md`](progress.md) | 可选：历史归档 / 项目级大事记；执行记录默认写各任务文件 |
|
||
| [`docs/README.md`](docs/README.md) | 文档导航，总览所有项目文档 |
|
||
| [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md) | AI coding agent 的入口、阅读顺序、任务领取规则 |
|
||
| [`docs/01-vision.md`](docs/01-vision.md) | 项目为什么做、为谁做、什么不做 |
|
||
| [`docs/02-requirements.md`](docs/02-requirements.md) | 产品需求、用户故事、验收标准 |
|
||
| [`docs/03-tech-stack.md`](docs/03-tech-stack.md) | 技术选型和运行命令 |
|
||
| [`docs/04-architecture.md`](docs/04-architecture.md) | 系统结构、职责边界、数据模型、开发顺序 |
|
||
| [`docs/05-coding-rules.md`](docs/05-coding-rules.md) | AI 写代码前必须遵守的硬规则 |
|
||
| [`docs/06-tasks.md`](docs/06-tasks.md) | 任务路线图：阶段划分、里程碑、待办池（只读，不跟踪单任务状态） |
|
||
| [`docs/tasks/README.md`](docs/tasks/README.md) | 默认任务管理：一任务一文件 `docs/tasks/T-<编号>.md`，单/多 agent 通用 |
|
||
| [`docs/adoption-checklist.md`](docs/adoption-checklist.md) | 已有项目接入 harness 文档的迁移清单 |
|
||
| [`docs/api.md`](docs/api.md) | API 合约模板 |
|
||
| [`docs/routes.md`](docs/routes.md) | 页面路由、组件归属、导航规则 |
|
||
| [`docs/clean-state-checklist.md`](docs/clean-state-checklist.md) | 会话收尾检查清单，保证下一轮无需人工修复即可开工 |
|
||
| [`docs/current-state.md`](docs/current-state.md) | 当前实现状态快照，防止计划和代码现实脱节 |
|
||
| [`docs/method-map.md`](docs/method-map.md) | 失败模式 → 首要修复 → 工件的诊断 / 导航对照表 |
|
||
| [`docs/evaluator-rubric.md`](docs/evaluator-rubric.md) | 单次会话输出的结构化评审评分表 |
|
||
| [`docs/quality-document.md`](docs/quality-document.md) | 代码库长期健康度追踪（产品域 × 架构层评级） |
|
||
|
||
## 使用方式
|
||
|
||
### 最小必选集
|
||
|
||
只想先让 agent 稳定工作时，先复制这些文件：
|
||
|
||
- `AGENTS.md`
|
||
- `CLAUDE.md`
|
||
- `docs/00-ai-start-here.md`
|
||
- `docs/05-coding-rules.md`
|
||
- `docs/06-tasks.md`
|
||
- `docs/tasks/`（`README.md` + `_template.md`）
|
||
- `docs/current-state.md`
|
||
- `init.sh` 或 `init.ps1`
|
||
|
||
### 完整推荐集
|
||
|
||
新项目从零开始时，建议复制根目录入口文件和 `docs/` 目录（含 `docs/tasks/`），并按操作系统选择 `init.sh` 或 `init.ps1`。复制后按顺序处理：
|
||
|
||
1. 从 `docs/01-vision.md` 和 `docs/02-requirements.md` 开始替换业务内容。
|
||
2. 在 `docs/03-tech-stack.md` 固定技术选型，不确定的选项标为待定。
|
||
3. 在 `docs/04-architecture.md` 写清事实来源、数据模型、系统边界。
|
||
4. 在 `docs/06-tasks.md` 拆出阶段路线图和建议任务；开工时按 `docs/tasks/README.md` 把任务落成 `docs/tasks/T-<编号>.md`，要求 AI 每轮只领取一个任务。
|
||
5. 替换 `init.sh` 或 `init.ps1` 顶部三个命令，并把真实命令同步到 `docs/03-tech-stack.md`、`docs/00-ai-start-here.md` 和 `docs/current-state.md`。
|
||
6. 执行记录写进各任务文件的 `## 执行记录`，用 `docs/current-state.md` 覆盖更新当前快照；`progress.md` 可选，用作历史归档或项目级大事记。
|
||
7. 开始编码前，让 agent 先读 `docs/00-ai-start-here.md`。
|
||
|
||
### 已有项目接入
|
||
|
||
已有代码仓库不要急着让 agent 做新功能。先按 [`docs/adoption-checklist.md`](docs/adoption-checklist.md) 建立当前状态、启动路径、验证路径和任务文件；第一轮任务优先修复基线，而不是扩大功能范围。
|
||
|
||
### 可选增强集
|
||
|
||
项目进入多轮长期开发后，再按需启用：
|
||
|
||
- `docs/clean-state-checklist.md`：每轮结束前检查仓库是否可恢复。
|
||
- `docs/method-map.md`：遇到失败模式时定位该补哪个工件。
|
||
- `docs/evaluator-rubric.md`：评审单次 agent 输出质量。
|
||
- `docs/quality-document.md`：追踪代码库长期健康度。
|
||
|
||
`tasks.md` 是本样本库自身的维护任务；复制到新项目后，项目任务默认以一任务一文件写在 `docs/tasks/`，阶段路线图维护在 `docs/06-tasks.md`。
|
||
|
||
核心原则：文档不是给人看的装饰，而是给 agent 执行时用的约束、事实来源和验收标准。 |