docs(repo):完善协作规则与任务账本
bat-rust / Build and test Rust (push) Canceled after 0s
bat-rust / Build and test Go API (push) Canceled after 0s

This commit is contained in:
2026-09-13 18:33:08 +08:00
parent 37d49c9793
commit 32fc64fa83
4 changed files with 1631 additions and 6 deletions
+29 -2
View File
@@ -1,6 +1,6 @@
# BlueArchive Toolkit 文档分类索引
- **更新时间**2026-09-04
- **更新时间**2026-09-13
- **用途**:按用途、时效性和权威级别定位文档。
- **原则**:目录是物理归档方式,不能单独代表文档权威性;当前源码、测试和下列当前文档优先于历史报告。
@@ -16,6 +16,8 @@
- `CHANGELOG.md`:版本变更记录,不作为当前实现的唯一依据。
- `CLAUDE.md`:旧工具兼容入口,不承载独立规则。
- `AGENTS.md`AI agent 长期协作规则。
- `TODO.md`:具体工程任务、优先级、依赖与完成条件的仓库内任务账本;不作为当前实现事实来源。
- `DESIGN.md`:Dashboard 的主要视觉参考与设计灵感来源;涉及 Dashboard/Web UI/布局/视觉/组件/交互任务时必须先阅读。
## 2. 当前状态、计划与缺口
@@ -25,6 +27,7 @@
- `docs/reports/GO_STATUS.md`Go `bat-api` 边界和组件进度的权威文档。
- `docs/reports/CURRENT_GAPS.md`:当前缺口、影响和推进顺序。
- `PROJECT_PLAN.md`:目标和路线图;其中的计划项不等于已实现。
- `TODO.md`:当前可执行工程任务、优先级、依赖与验收条件;条目状态不高于源码、测试和 current-status 文档。
- `docs/reports/BAT_API_CONTRACT_FIXTURE_HANDOFF.md`Rust 输出、Go contract fixture 和联调的当前交接说明。
## 3. 架构、决策与稳定契约
@@ -51,6 +54,15 @@
契约文档涉及字段、状态码、错误码、release layout 或路径语义时,必须与源码测试和 `internal/api/testdata/contract/` 一起复核。
### 3.4 Dashboard 设计参考
- `DESIGN.md`:用户 Dashboard 与运营 Dashboard 的主要视觉参考和设计灵感来源,描述应延续的色彩关系、排版、空间、边框、层级、组件形态和交互气质。它不定义后端事实、权限或业务状态,也不要求复制参考来源的页面结构或品牌内容。
- Dashboard 的稳定产品职责、信息边界和设计执行规则见 `AGENTS.md` 的“Dashboard 开发与设计”。用户 Dashboard 与运营 Dashboard 共享基础视觉语言和组件体系,但拥有不同的信息架构、信息密度和权限边界。
- Dashboard 设计必须以当前真实 API/RPC contract 和数据结构为依据。若所需信息尚无后端 contract,应记录缺口,而不是在前端维护第二份业务状态或伪造指标。
发生冲突时遵循:`AGENTS.md` 与稳定产品/接口契约 > 当前明确任务需求 > `DESIGN.md` > Agent 自身设计偏好。
## 4. 用户、开发与运维指南
这些文件描述如何使用或验证已经存在的能力:
@@ -118,6 +130,8 @@
## 8. 推荐阅读顺序
### 8.1 项目与开发者通用阅读顺序
1. `README.md`
2. `CURRENT_STATUS.md`
3. `PROJECT_PLAN.md`
@@ -133,4 +147,17 @@
13. `CONTRIBUTING.md`
14. `AGENTS.md`
阅读顺序中的状态和契约结论必须回到当前源码、测试和实际命令验证;历史报告只用于解释演进过程。
### 8.2 AI / Agent 开发接管顺序
Agent 进入仓库进行开发时优先按以下顺序建立上下文:
1. `AGENTS.md`:先确定长期规则、状态所有权和开发边界;
2. `DOCS_INDEX.md`:确认当前任务应阅读的权威文档;
3. `CURRENT_STATUS.md` 与对应专项状态文档:确认当前已经实现的事实;
4. `TODO.md`:确认当前具体任务、优先级、依赖和完成条件;
5. 当前任务直接相关的源码、tests、稳定 contract 和架构文档;
6. `docs/reports/CURRENT_GAPS.md` / `PROJECT_PLAN.md`:需要判断能力缺口或后续路线时再读取。
涉及 Dashboard、Web UI、页面布局、视觉样式、组件或交互体验时,在设计或修改前额外必须阅读 `DESIGN.md`
阅读顺序中的状态和契约结论必须回到当前源码、测试和实际命令验证;`TODO.md``CURRENT_GAPS.md``PROJECT_PLAN.md` 均不能把计划项提升为已实现事实;历史报告只用于解释演进过程。