From d6c0e5b612ea23b6b33f1f5fa0c8131cfb2e4c6f Mon Sep 17 00:00:00 2001 From: QiuSW Date: Mon, 22 Jun 2026 22:26:57 +0800 Subject: [PATCH] docs: add project task list --- AGENTS.md | 8 ++++++ CLAUDE.md | 8 ++++++ README.md | 1 + docs/README.md | 1 + tasks.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 86 insertions(+) create mode 100644 tasks.md diff --git a/AGENTS.md b/AGENTS.md index 1ebf2fc..d135d54 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -8,6 +8,14 @@ 当前不是业务应用代码仓库，而是文档模板仓库。默认任务是维护、改进、补充这些模板，让它们更适合复制到新项目中使用。 +## 文档位置 + +harness coding 需要的项目文档模板集中在 `docs/` 目录。 + +后续 Codex 或其他 AI coding agent 进入使用这些模板的新项目时，应先读取仓库级规则文件，再从 `docs/00-ai-start-here.md` 开始建立上下文；该文件会继续导航到需求、技术栈、架构、编码规则、任务看板和当前状态。 + +根目录 `README.md` 和 `docs/README.md` 主要用于人类快速了解样本库和文档清单；agent 真正开始编程时，以 `docs/00-ai-start-here.md` 作为工作入口。 + ## 必读顺序 每次开始工作前，按顺序读取： diff --git a/CLAUDE.md b/CLAUDE.md index 1a6218a..cc0f2d1 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,6 +8,14 @@ 这套模板参考了 `D:\opc_project\lingo\docs` 的真实项目文档结构，但本仓库产物应保持通用，不绑定 lingo 的业务、数据、技术栈或任务状态。 +## 文档位置 + +harness coding 需要的项目文档模板集中在 `docs/` 目录。 + +后续 Claude Code 进入使用这些模板的新项目时，应先读取仓库级规则文件，再从 `docs/00-ai-start-here.md` 开始建立上下文；该文件会继续导航到需求、技术栈、架构、编码规则、任务看板和当前状态。 + +根目录 `README.md` 和 `docs/README.md` 主要用于人类快速了解样本库和文档清单；Claude Code 真正开始编程时，以 `docs/00-ai-start-here.md` 作为工作入口。 + ## 关键事实 - 根目录 `README.md` 是样本库总入口。 diff --git a/README.md b/README.md index 455b171..36e7b0e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ | --- | --- | | [`AGENTS.md`](AGENTS.md) | Codex / 通用 AI coding agent 的仓库级入口 | | [`CLAUDE.md`](CLAUDE.md) | Claude Code 的仓库级上下文入口 | +| [`tasks.md`](tasks.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) | 项目为什么做、为谁做、什么不做 | diff --git a/docs/README.md b/docs/README.md index 5c039d6..6cfd097 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,6 +14,7 @@ - [`../AGENTS.md`](../AGENTS.md)：Codex / 通用 AI coding agent 的仓库级入口。 - [`../CLAUDE.md`](../CLAUDE.md)：Claude Code 的仓库级上下文入口。 +- [`../tasks.md`](../tasks.md)：当前样本库自身的维护任务列表，不是复制到新项目后的业务任务看板。 - [AI 开发入口](00-ai-start-here.md)：agent 每次开始工作的入口、阅读顺序和任务领取规则。 - [项目愿景](01-vision.md)：为什么做、为谁做、产品原则、非目标。 - [需求](02-requirements.md)：要什么、用户故事、验收标准，不写技术实现。 diff --git a/tasks.md b/tasks.md new file mode 100644 index 0000000..eb8dbb9 --- /dev/null +++ b/tasks.md @@ -0,0 +1,68 @@ +# Harness Coding 样本库任务列表 + +> 本文件记录当前文档样本库自身的拆分任务。 +> 复制到新项目后，项目开发任务应写入 `docs/06-tasks.md`，不要把本文件当成业务项目任务看板。 + +## 使用规则 + +- 每次只领取一个状态为 `TODO` 且依赖均已 `DONE` 的任务。 +- 修改模板前先读 `AGENTS.md`、`CLAUDE.md` 和相关 `docs/` 文件。 +- 新增、改名或删除文档时，同步检查 `README.md` 和 `docs/README.md`。 +- 改完后至少运行： + +```powershell +Get-ChildItem -Recurse -File +``` + +如涉及链接、文件名或入口说明，继续用 `rg` 检查引用一致性。 + +## 状态图例 + +`TODO` 待开始 · `DOING` 进行中 · `DONE` 已完成 · `BLOCKED` 受阻 + +## Phase 0 · 仓库入口 + +| ID | 任务 | 依赖 | 验收要点 | 状态 | +| --- | --- | --- | --- | --- | +| H-001 | 建立 Codex 入口 `AGENTS.md` | - | 说明仓库定位、必读顺序、工作规则和验证方式 | DONE | +| H-002 | 建立 Claude Code 入口 `CLAUDE.md` | - | 说明 Claude Code 读取顺序、模板边界和禁止事项 | 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-005 | 建立样本库任务列表 `tasks.md` | H-001 | 根目录存在维护任务列表，并和 `docs/06-tasks.md` 职责区分清楚 | DONE | + +## Phase 1 · 核心模板 + +| ID | 任务 | 依赖 | 验收要点 | 状态 | +| --- | --- | --- | --- | --- | +| H-101 | 建立文档导航 `docs/README.md` | H-003 | 能快速找到入口、愿景、需求、技术栈、架构、规则、任务、API、路由和当前状态 | DONE | +| H-102 | 建立 AI 开发入口模板 `docs/00-ai-start-here.md` | H-101 | 包含必读顺序、任务领取规则、MVP 边界、事实来源和验证命令 | DONE | +| H-103 | 建立愿景模板 `docs/01-vision.md` | H-102 | 能约束为什么做、为谁做、产品原则和非目标 | DONE | +| H-104 | 建立需求模板 `docs/02-requirements.md` | H-103 | 能表达功能范围、用户故事、优先级和验收标准 | DONE | +| H-105 | 建立技术栈模板 `docs/03-tech-stack.md` | H-104 | 能固定框架、依赖、运行命令和待定项 | DONE | +| H-106 | 建立架构模板 `docs/04-architecture.md` | H-105 | 能表达系统边界、模块职责、数据模型和开发顺序 | DONE | +| H-107 | 建立编码规则模板 `docs/05-coding-rules.md` | H-106 | 能约束事实来源、范围、架构、代码规范和验证 | DONE | +| H-108 | 建立任务看板模板 `docs/06-tasks.md` | H-107 | 能指导 agent 每轮只领取一个小任务 | DONE | + +## Phase 2 · 辅助模板 + +| ID | 任务 | 依赖 | 验收要点 | 状态 | +| --- | --- | --- | --- | --- | +| 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 | + +## Phase 3 · 一致性维护 + +| ID | 任务 | 依赖 | 验收要点 | 状态 | +| --- | --- | --- | --- | --- | +| H-301 | 检查入口文件之间的职责是否重复 | H-005 | `AGENTS.md`、`CLAUDE.md`、`README.md`、`docs/README.md`、`docs/00-ai-start-here.md` 各自职责清楚 | TODO | +| H-302 | 检查所有模板是否保持通用占位符 | H-201, H-202, H-203 | 没有混入只适用于某个真实项目的业务事实 | TODO | +| H-303 | 检查链接和文件名引用一致性 | H-301 | `rg` 搜索无旧名称、坏路径或冲突说明 | TODO | +| H-304 | 补充复制到新项目后的使用流程 | H-302 | README 和入口模板能指导用户从复制、替换占位符到开始编程 | TODO | + +## Backlog + +- 增加“从空项目初始化文档”的操作清单。 +- 增加“已有项目补齐 harness coding 文档”的迁移清单。 +- 增加“任务拆分质量检查表”。 +- 增加“文档与代码现实不一致时的处理流程”。