44 lines
2.8 KiB
Markdown
44 lines
2.8 KiB
Markdown
# 项目文档导航
|
||
|
||
> 复制到新项目后，先替换本文中的项目名称和一句话定位，再逐个补齐后续文档。
|
||
|
||
## 一句话定位
|
||
|
||
【项目名】是一个【目标用户】使用的【产品类型 / 系统类型】，用于解决【核心问题】，第一版先完成【MVP 闭环】。
|
||
|
||
示例：
|
||
|
||
> 这是一个面向小团队的工单协作系统，第一版先跑通「提交工单 -> 分派 -> 处理 -> 关闭」闭环。
|
||
|
||
## 文档导航
|
||
|
||
- [`../AGENTS.md`](../AGENTS.md)：Codex / 通用 AI coding agent 的仓库级入口。
|
||
- [`../CLAUDE.md`](../CLAUDE.md)：Claude Code 的薄入口，具体规则以 `AGENTS.md` 为准。
|
||
- [`../tasks.md`](../tasks.md)：当前样本库自身的维护任务列表，不是复制到新项目后的业务任务看板。
|
||
- [`../progress.md`](../progress.md)：复制到新项目后的执行历史流水，只追加记录任务执行、验证、阻塞和决策。
|
||
- [AI 开发入口](00-ai-start-here.md)：agent 每次开始工作的入口、阅读顺序和任务领取规则。
|
||
- [项目愿景](01-vision.md)：为什么做、为谁做、产品原则、非目标。
|
||
- [需求](02-requirements.md)：要什么、用户故事、验收标准，不写技术实现。
|
||
- [技术栈](03-tech-stack.md)：确定使用哪些框架、库、数据库、部署方式。
|
||
- [架构设计](04-architecture.md)：系统结构、模块职责、数据模型、关键风险和开发顺序。
|
||
- [编码规则](05-coding-rules.md)：AI 写代码前必须遵守的硬约束。
|
||
- [任务看板](06-tasks.md)：按依赖拆分的小任务，agent 每轮只做一个。
|
||
- [API 合约](api.md)：前后端接口形状、错误格式、鉴权约定。
|
||
- [路由与页面结构](routes.md)：页面路由、页面职责、组件归属。
|
||
- [当前实现状态](current-state.md)：可覆盖的当前快照，记录仓库现实状态、可运行命令和下一步可做任务。
|
||
|
||
## 任务 / 进度 / 当前状态
|
||
|
||
- `06-tasks.md` 维护任务看板：任务 ID、依赖、验收要点和状态。
|
||
- `../progress.md` 维护执行进度：每轮实际做了什么、跑了什么验证、遇到什么阻塞、做了什么决策。
|
||
- `current-state.md` 维护当前快照：当前目录、当前可运行命令、已完成任务摘要和下一个可领取任务。
|
||
|
||
如果新项目希望任务看板放在根目录，可把 `06-tasks.md` 复制或改名为根目录 `tasks.md`，并同步更新本文、`00-ai-start-here.md` 和 `current-state.md` 的链接。
|
||
|
||
## 维护原则
|
||
|
||
- 需求变化先改文档，再改代码。
|
||
- 代码现实变化后同步 `current-state.md` 和 `06-tasks.md`，执行过程追加到 `../progress.md`。
|
||
- API、数据模型、路由、技术栈一旦在文档中定稿，代码不得另起一套。
|
||
- agent 开始新任务前，必须从 `00-ai-start-here.md` 进入。
|