harness_coding_docs/README.md

# 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) | 本样本库自身的维护任务列表 |
| [`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/api.md`](docs/api.md) | API 合约模板 |
| [`docs/routes.md`](docs/routes.md) | 页面路由、组件归属、导航规则 |
| [`docs/current-state.md`](docs/current-state.md) | 当前实现状态快照，防止计划和代码现实脱节 |

## 使用方式

1. 复制 `docs/`、`progress.md` 和需要的仓库级 agent 入口文件到新项目。
2. 从 `01-vision.md` 和 `02-requirements.md` 开始替换业务内容。
3. 在 `03-tech-stack.md` 固定技术选型，不确定的选项标为待定。
4. 在 `04-architecture.md` 写清事实来源、数据模型、系统边界。
5. 在 `06-tasks.md` 拆出小任务，要求 AI 每轮只领取一个任务。
6. 用 `progress.md` 追加记录每轮执行历史，用 `current-state.md` 覆盖更新当前快照。
7. 开始编码前，让 agent 先读 `00-ai-start-here.md`。

`tasks.md` 是本样本库自身的维护任务；复制到新项目后，项目任务默认写在 `docs/06-tasks.md`。如果新项目希望把任务看板放在根目录，可把 `docs/06-tasks.md` 复制或改名为根目录 `tasks.md`，并同步更新 `docs/README.md`、`docs/00-ai-start-here.md` 和 `docs/current-state.md` 中的链接。

核心原则：文档不是给人看的装饰，而是给 agent 执行时用的约束、事实来源和验收标准。