refactor(architecture): 信息架构重构 — 从"人类导向单体文档"到"AI优先分层架构"
新增四层信息架构: - Layer 0: 角色工作台 (.ai/roles/) — AI 每天只需读2个小文件 - Layer 1: 路线图看板 (ROADMAP.md) — 人机共享进度 - Layer 2: 阶段上下文 (.ai/phases/) — 按当前阶段加载 - Layer 3: 知识沉淀 (.ai/knowledge/) — 决策/模式/教训自动积累 新增: - DASHBOARD.md — 人类仪表盘(30秒了解全貌) - ROADMAP.md — 任务看板+阻塞追踪 - docs/share/ — 对外分享内容层(一鸡多吃) - docs/使用手册.md — 人+AI使用手册 - .ai/prompts/architecture/ — 补充缺失的架构提示词 - .ai/principles.md — 信息架构设计原则 - review/active/INDEX.md — 任务索引 修改: - AGENTS.md: 239行→117行,顶部AI跳转 - README.md: 精简聚焦人类读者 - PROJECT_CONTEXT.md: 精简+分层说明 - DECISIONS.md: 替换为跳转存根 - 5个task.md: 添加phase字段 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# 架构决策记录 (ADR)
|
||||
|
||||
## ADR-001: "1 人 + 2 AI" 协作框架
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳(后升级为 1 人 + 3 AI)
|
||||
- 决策: 采用人类负责人 + Dev AI + QA AI 的三角协作模式
|
||||
- 理由: 单人开发需要 AI 辅助,但 AI 不能互审,需要人类做最终决策
|
||||
- 影响: 定义了 R/W/RW/- 四级权限体系
|
||||
|
||||
## ADR-002: 四级权限体系
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳
|
||||
- 决策: 采用 `-`(禁止) / `R`(只读) / `W`(可写) / `RW`(读写) 四级权限,比二进制的读写更精细
|
||||
- 理由: AI 角色需要明确的边界,"只读但不能写"和"完全不可见"需要区分
|
||||
- 影响: 所有目录访问按权限矩阵执行,`forbidden > read_only > allowed` 优先级
|
||||
|
||||
## ADR-003: 根级 docs/ 目录
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳
|
||||
- 决策: 项目级文档放在根目录 `docs/` 而非子项目内
|
||||
- 理由: 跨项目共享的文档(架构设计、开发规范)不应属于某个子项目
|
||||
- 影响: docs/ 由 Arch AI 和 Dev AI 共同维护
|
||||
|
||||
## ADR-004: 独立 tools/ 和 data/ 目录
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳
|
||||
- 决策: 开发工具脚本和训练数据从 shared/ 中独立出来
|
||||
- 理由: tools 和 data 的使用场景和权限需求与 shared 不同
|
||||
- 影响: Arch AI 和 Dev AI 可写 tools/ 和 data/,QA AI 只能读 data/
|
||||
|
||||
## ADR-005: 工作流重试和升级机制
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳
|
||||
- 决策: 测试 → 修复循环最多 3 轮,Round 3 仍有 BLOCKER/HIGH 则升级给人类
|
||||
- 理由: 防止无限循环,确保严重问题得到人类关注
|
||||
- 影响: `skip_acceptance_on_retry: true`,修复轮次不重写验收标准
|
||||
|
||||
## ADR-006: resume-context Skill 多机同步
|
||||
|
||||
- 日期: 2026-05-23
|
||||
- 状态: 已采纳
|
||||
- 决策: 通过 `resume-context` Skill 实现换电脑时上下文恢复
|
||||
- 理由: 用户在家和公司两台电脑开发,需要快速恢复 AI 工作上下文
|
||||
- 影响: 角色检测、关键文档加载、上下文摘要生成
|
||||
|
||||
## ADR-007: 分层信息架构 + Token 预算
|
||||
|
||||
- 日期: 2026-05-25
|
||||
- 状态: 已采纳
|
||||
- 决策: 采用四层信息架构(工作台 → 路线图 → 阶段上下文 → 知识沉淀),每层有 token 预算
|
||||
- 理由: AI 上下文窗口有限(~200K tokens),旧 AGENTS.md 单体文件浪费 token;每个 AI 角色只需要知道自己该干什么
|
||||
- 影响: 所有 AI 从 `.ai/roles/{role}/` 启动;新增 `ROADMAP.md`、`DASHBOARD.md`、`docs/share/` 分享层
|
||||
@@ -0,0 +1,35 @@
|
||||
# 2026-05-25 — 信息架构重构
|
||||
|
||||
## 做了什么
|
||||
|
||||
完成项目信息架构从"人类导向单体文档"到"AI 优先分层架构"的全面重构。
|
||||
|
||||
### 新增 (~35 个文件)
|
||||
|
||||
- **角色工作台** (`.ai/roles/`): 为 Arch/Dev/QA 三个 AI 角色各创建 card.md + today.md + queue.md,AI 每天只需读 2 个小文件即可开工
|
||||
- **阶段上下文** (`.ai/phases/`): Phase 1-4 的阶段目标、范围、架构决策文档。当前 Phase 1 已填充,Phase 2-4 为模板占位
|
||||
- **知识沉淀** (`.ai/knowledge/`): decisions.md(迁移 6 个旧 ADR + 新增 ADR-007)、patterns.md、lessons.md
|
||||
- **架构提示词** (`.ai/prompts/architecture/`): 补充之前缺失的架构设计和技术选型模板
|
||||
- **分享层** (`.ai/share/`): 阶段复盘模板、决策故事模板、项目缘起和框架设计思路占位
|
||||
- **人类仪表盘** (DASHBOARD.md): 根目录,30 秒可读
|
||||
- **路线图看板** (ROADMAP.md): 阶段进度 + 任务看板 + 阻塞项,人机共享
|
||||
- **任务索引** (review/active/INDEX.md): 所有活跃任务一览
|
||||
|
||||
### 修改 (6 个文件)
|
||||
|
||||
- AGENTS.md: 239 行 → ~120 行,顶部 AI 跳转
|
||||
- README.md: 精简,聚焦人类读者
|
||||
- docs/PROJECT_CONTEXT.md: 精简,加跳转链接
|
||||
- docs/DECISIONS.md: 替换为跳转存根
|
||||
- 5 个 task.md: 添加 phase 字段
|
||||
|
||||
## 关键决策
|
||||
|
||||
1. 分层信息架构:工作台 → 路线图 → 阶段上下文 → 知识沉淀
|
||||
2. Token 预算制度:每个文件标注预算上限
|
||||
3. "一鸡多吃":开发过程自动沉淀为可分享内容
|
||||
4. 角色工作台代替全局 AGENTS.md 作为 AI 入口
|
||||
|
||||
## 经验教训
|
||||
|
||||
见 lessons.md L-001: 单体 AGENTS.md 浪费 AI 上下文
|
||||
@@ -0,0 +1,25 @@
|
||||
# 经验教训
|
||||
|
||||
## 目的
|
||||
|
||||
记录开发过程中学到的东西。每条记录包含:
|
||||
- 上下文(我们在做什么)
|
||||
- 问题(出了什么问题/什么让我们意外)
|
||||
- 教训(学到了什么)
|
||||
- 行动(因此改变了什么)
|
||||
|
||||
---
|
||||
|
||||
## L-001: 单体 AGENTS.md 浪费 AI 上下文
|
||||
|
||||
**日期**: 2026-05-25
|
||||
**上下文**: 项目启动阶段,每次 AI 会话都需要读 AGENTS.md 来了解角色和权限
|
||||
**问题**: AGENTS.md 239 行,约 80% 内容与当前 AI 角色无关。AI 有效上下文被大量无关信息占据
|
||||
**教训**: 为人类设计的文档结构不适用于 AI 的信息获取模式。AI 需要"最少必要信息",而不是"全局完整视图"
|
||||
**行动**: 重构为分层信息架构:角色工作台 → 阶段上下文 → 知识沉淀。AI 只需读 2 个小文件即可开工
|
||||
|
||||
---
|
||||
|
||||
## L-002
|
||||
|
||||
*(待项目推进中记录)*
|
||||
@@ -0,0 +1,39 @@
|
||||
# 可复用模式
|
||||
|
||||
## 目的
|
||||
|
||||
记录开发过程中发现的可持续复用的模式和做法。
|
||||
同样的模式出现 3 次以上时,应当记录在这里。
|
||||
|
||||
---
|
||||
|
||||
## P-001: AI 任务交接 (review/active/)
|
||||
|
||||
**上下文**: AI 角色之间需要传递工作成果
|
||||
**问题**: 如何结构化任务交接,让任何 AI 都能接手
|
||||
**方案**: 标准化 `review/active/{任务ID}/` 结构:
|
||||
- `task.md` — 任务描述(Arch AI 定义)
|
||||
- `acceptance.md` — 验收标准(Arch AI + Dev AI + QA AI 共同维护)
|
||||
- `impact.md` — 变更影响范围(Arch AI + Dev AI 评估)
|
||||
- `feedback/` — 反馈记录(QA AI 提交)
|
||||
|
||||
**何时用**: 每个跨 AI 角色的任务
|
||||
**何时不用**: 单角色任务(如纯文档更新、配置修改)
|
||||
|
||||
---
|
||||
|
||||
## P-002: 角色工作台 (daily task board)
|
||||
|
||||
**上下文**: AI 每次会话需要快速进入工作状态
|
||||
**问题**: 从头探索项目结构浪费时间
|
||||
**方案**: `.ai/roles/{role}/today.md` 每日任务清单,AI 只需读 2 个文件(card + today)
|
||||
**何时用**: 每次 AI 会话
|
||||
**维护者**: Arch AI 负责分配,各 AI 自己更新完成状态
|
||||
|
||||
---
|
||||
|
||||
## 反模式(避免)
|
||||
|
||||
- 在多个文件中重复同一状态信息 → 只在 ROADMAP.md 记录
|
||||
- 决策讨论散落在任务 feedback 中 → 提炼到 knowledge/decisions.md
|
||||
- 大段文档内联而非链接 → 用链接 + 一句话摘要
|
||||
@@ -0,0 +1,17 @@
|
||||
# 阶段索引
|
||||
|
||||
| 阶段 | 名称 | 状态 | 目录 |
|
||||
|------|------|------|------|
|
||||
| 1 | 基础搭建 | ACTIVE | `phase-01-foundation/` |
|
||||
| 2 | MVP | PLANNED | `phase-02-mvp/` |
|
||||
| 3 | 功能完善 | PLANNED | `phase-03-features/` |
|
||||
| 4 | 打磨发布 | PLANNED | `phase-04-polish/` |
|
||||
|
||||
## 阶段切换规则
|
||||
|
||||
1. 当前阶段 completion.md 全部打勾
|
||||
2. 人类签字确认
|
||||
3. Arch AI 更新本索引文件
|
||||
4. Arch AI 更新所有角色 card.md
|
||||
5. Arch AI 更新 ROADMAP.md
|
||||
6. 产出阶段复盘(docs/share/phase-NN/)
|
||||
@@ -0,0 +1,45 @@
|
||||
# Phase 1: 基础搭建 — 架构概览
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 层 | 技术 | 说明 |
|
||||
|----|------|------|
|
||||
| 前端 (P01) | Taro 4 + React 18 + TypeScript + Tailwind CSS | 跨端小程序 |
|
||||
| 后端 (P01) | NestJS 10 + TypeScript | REST API |
|
||||
| 数据库 | PostgreSQL(Schema 本阶段确定) | 关系型存储 |
|
||||
| 包管理 | pnpm | monorepo |
|
||||
| 测试 | Jest | 单元 + 集成 + E2E |
|
||||
| AI 训练 (P02) | Python + PyTorch | 延期至 Phase 2 |
|
||||
| Web 后台 (P03) | Next.js | 延期至 Phase 2 |
|
||||
|
||||
## 当前架构快照
|
||||
|
||||
```
|
||||
P01_errlens_app/
|
||||
src/ # Taro 小程序源码(已有骨架)
|
||||
pages/index/ # 首页(通用模板,待替换为错题本首页)
|
||||
components/ui/ # shadcn/ui Taro 组件库(~50个组件)
|
||||
lib/ # 工具函数(cn, platform, measure, hooks)
|
||||
presets/ # H5 适配(navbar, error boundary, styles)
|
||||
server/ # NestJS 后端
|
||||
src/
|
||||
main.ts # 启动入口
|
||||
app.module.ts # 根模块
|
||||
app.controller.ts # GET /hello, GET /health
|
||||
tests/ # Jest 测试(已有 utils 测试骨架)
|
||||
|
||||
P02_errlens_training/ # 空壳,Phase 2 启动
|
||||
P03_errlens_web/ # 空壳,Phase 2 启动
|
||||
```
|
||||
|
||||
## 关键约束
|
||||
|
||||
- 所有业务代码在 projects/*/src/(权限边界)
|
||||
- 跨平台目标:微信小程序优先,抖音/H5 为次
|
||||
- AI 代码必须遵循 `.ai/prompts/coding/code-style.md`
|
||||
|
||||
## 待定问题
|
||||
|
||||
- 数据库 Schema 设计(PRD 先行)
|
||||
- P01 页面架构(几个页面、导航结构)
|
||||
- 后端 API 版本策略
|
||||
@@ -0,0 +1,16 @@
|
||||
# Phase 1: 基础搭建 — 完成检查清单
|
||||
|
||||
## 完成状态
|
||||
|
||||
- [ ] 所有 goal.md 中的成功标准达成
|
||||
- [ ] 所有活跃任务处于 DONE 或 ARCHIVED
|
||||
- [ ] QA AI 签字确认
|
||||
- [ ] 人类签字确认
|
||||
- [ ] 知识已沉淀至 .ai/knowledge/
|
||||
- [ ] Phase 2 MVP 计划已起草
|
||||
- [ ] 阶段复盘已写出(docs/share/phase-01/)
|
||||
- [ ] Token 预算审计通过
|
||||
|
||||
## 阶段交接
|
||||
|
||||
*(阶段接近完成时填写)*
|
||||
@@ -0,0 +1,27 @@
|
||||
# Phase 1: 基础搭建 — 阶段决策
|
||||
|
||||
本文件记录在 Phase 1 执行过程中产生的决策(区别于全局 ADR)。
|
||||
|
||||
## D-001: 信息架构分层设计
|
||||
|
||||
- 日期: 2026-05-25
|
||||
- 状态: 已采纳
|
||||
- 决策: 采用 token 预算的分层架构(工作台 → 阶段 → 知识 → 分享)
|
||||
- 理由: AI 上下文窗口有限,旧 AGENTS.md 单体文件浪费 token
|
||||
- 影响: 所有 AI 从 `.ai/roles/{role}/` 启动,不再从 AGENTS.md 启动
|
||||
|
||||
## D-002: 阶段化上下文加载
|
||||
|
||||
- 日期: 2026-05-25
|
||||
- 状态: 已采纳
|
||||
- 决策: AI 只加载当前 Phase 的上下文,不加载所有历史
|
||||
- 理由: 未来阶段技术栈和侧重点可能不同,历史信息反而干扰
|
||||
- 影响: 阶段包必须自包含、可独立阅读
|
||||
|
||||
## D-003: 角色工作台代替全局入口
|
||||
|
||||
- 日期: 2026-05-25
|
||||
- 状态: 已采纳
|
||||
- 决策: 用 `today.md` + `queue.md` 替代从 AGENTS.md 找任务
|
||||
- 理由: AI 不需要理解整个项目结构,只需要知道自己该干什么
|
||||
- 影响: Arch AI 负责维护各角色的任务分配
|
||||
@@ -0,0 +1,27 @@
|
||||
# Phase 1: 基础搭建 — 目标
|
||||
|
||||
## 阶段目标
|
||||
|
||||
建立完整的开发骨架:
|
||||
- 可运转的"1 人 + 3 AI"协作框架
|
||||
- 完整的目录和权限体系
|
||||
- 可运行的项目脚手架(Taro + React + NestJS)
|
||||
- 测试基础设施
|
||||
- 信息架构设计(分层 AI 上下文)
|
||||
|
||||
## 成功标准
|
||||
|
||||
- [ ] 3 个 AI 角色能独立通过工作台启动工作
|
||||
- [ ] P01 可通过 `pnpm dev` 启动并显示首页
|
||||
- [ ] 测试可通过 `pnpm test` 运行并产出报告
|
||||
- [ ] 所有初始 review/ 任务处于 DONE 或 ARCHIVED
|
||||
- [ ] 共享工具库可工作并通过测试
|
||||
- [ ] 信息架构重构完成
|
||||
|
||||
## 阶段 Owner
|
||||
|
||||
Arch AI 协调,Dev AI 实现,QA AI 验证,人类最终验收。
|
||||
|
||||
## 下一阶段
|
||||
|
||||
Phase 2: MVP — 实现错题本核心功能
|
||||
@@ -0,0 +1,42 @@
|
||||
# Phase 1: 基础搭建 — 范围
|
||||
|
||||
## 范围内
|
||||
|
||||
### 协作框架
|
||||
- AGENTS.md(AI 角色 + 权限 + 工作流)
|
||||
- .ai/config/(JSON 角色配置)
|
||||
- .ai/prompts/(编码、测试、架构提示词模板)
|
||||
- .ai/roles/(AI 角色工作台)
|
||||
- .ai/phases/(阶段上下文)
|
||||
- review/(任务交接中心)
|
||||
|
||||
### P01_errlens_app(主应用)
|
||||
- Taro 4 + React 18 脚手架,集成 shadcn/ui
|
||||
- NestJS 后端脚手架
|
||||
- 可运行的开发服务器(pnpm dev)
|
||||
- 基础页面路由
|
||||
|
||||
### 测试基础设施
|
||||
- Jest 配置
|
||||
- 示例单元测试
|
||||
- 测试结果报告流程
|
||||
|
||||
### 文档体系
|
||||
- 阶段追踪文档
|
||||
- 知识库基础
|
||||
- 人类仪表盘
|
||||
- 分享内容层
|
||||
|
||||
## 范围外(延期至 Phase 2+)
|
||||
|
||||
- 实际业务功能(登录、错题分析等)
|
||||
- P02 数据训练实现
|
||||
- P03 Web 后台实现
|
||||
- CI/CD 流水线配置
|
||||
- 生产部署
|
||||
|
||||
## 项目依赖
|
||||
|
||||
- P01 独立(可独立开发)
|
||||
- P02 依赖 P01 定义数据 Schema(Phase 2)
|
||||
- P03 依赖 P01 API 稳定(Phase 3)
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 2: MVP — 架构决策
|
||||
|
||||
*(Phase 2 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 2: MVP — 完成检查清单
|
||||
|
||||
*(Phase 2 接近完成时更新)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 2: MVP — 阶段决策
|
||||
|
||||
*(Phase 2 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,11 @@
|
||||
# Phase 2: MVP — 目标
|
||||
|
||||
*(Phase 1 完成时由 Arch AI 填写)*
|
||||
|
||||
## 阶段目标
|
||||
|
||||
## 成功标准
|
||||
|
||||
## 阶段 Owner
|
||||
|
||||
## 下一阶段
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 2: MVP — 范围
|
||||
|
||||
*(Phase 1 完成时由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 3: 功能完善 — 架构决策
|
||||
|
||||
*(Phase 3 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 3: 功能完善 — 完成检查清单
|
||||
|
||||
*(Phase 3 接近完成时更新)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 3: 功能完善 — 阶段决策
|
||||
|
||||
*(Phase 3 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 3: 功能完善 — 目标
|
||||
|
||||
*(Phase 2 完成时由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 3: 功能完善 — 范围
|
||||
|
||||
*(Phase 2 完成时由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 4: 打磨发布 — 架构决策
|
||||
|
||||
*(Phase 4 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 4: 打磨发布 — 完成检查清单
|
||||
|
||||
*(Phase 4 接近完成时更新)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 4: 打磨发布 — 阶段决策
|
||||
|
||||
*(Phase 4 执行过程中由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 4: 打磨发布 — 目标
|
||||
|
||||
*(Phase 3 完成时由 Arch AI 填写)*
|
||||
@@ -0,0 +1,3 @@
|
||||
# Phase 4: 打磨发布 — 范围
|
||||
|
||||
*(Phase 3 完成时由 Arch AI 填写)*
|
||||
@@ -0,0 +1,47 @@
|
||||
# 信息架构设计原则
|
||||
|
||||
## 为什么这样设计
|
||||
|
||||
AI 的上下文窗口有限(~200K tokens)。当前架构按人类认知模式设计——详尽文档、全局视角——但 AI 每个读入上下文的字都是成本。这套分层架构的核心思想:**每个角色只加载必要信息,按需展开细节。**
|
||||
|
||||
## Token 预算
|
||||
|
||||
| 层级 | 预算 | 内容 | 加载时机 |
|
||||
|------|------|------|----------|
|
||||
| 角色工作台 (card + today) | < 2K | 身份+今日任务 | 每次会话必读 |
|
||||
| 阶段上下文 (phase) | < 5K | 目标+范围+架构 | 按需加载 |
|
||||
| 专题文档 (knowledge) | < 3K | 决策/模式/教训 | 按需加载 |
|
||||
| 路线图 (ROADMAP) | < 2K | 全局进度 | 需要全局视野时 |
|
||||
|
||||
## 信息分层
|
||||
|
||||
```
|
||||
Layer 0: 角色工作台 → AI 每天进来只读这个
|
||||
Layer 1: 路线图看板 → 人类 + AI 共享进度
|
||||
Layer 2: 阶段上下文 → 按当前阶段按需加载
|
||||
Layer 3: 知识沉淀 → 自动积累,永久沉淀
|
||||
```
|
||||
|
||||
## 维护规则
|
||||
|
||||
1. **不超预算**:每个文件严格遵守 token 预算,超了就拆分
|
||||
2. **不重复状态**:状态只在一处记录(ROADMAP.md),其他地方引用
|
||||
3. **Git 管历史**:文档只描述"现在是什么",历史由 Git 负责
|
||||
4. **一文一答**:每个文件独立回答一个问题,不需要串联阅读
|
||||
5. **角色无关设计**:任何 AI 模型都能通过读 card.md 快速接管角色
|
||||
|
||||
## 文件约定
|
||||
|
||||
- 角色工作台: `.ai/roles/{role}/`
|
||||
- 阶段上下文: `.ai/phases/phase-NN-name/`
|
||||
- 知识沉淀: `.ai/knowledge/`
|
||||
- 提示词模板: `.ai/prompts/{domain}/`
|
||||
|
||||
## 阶段切换检查清单
|
||||
|
||||
切换阶段时 Arch AI 必须:
|
||||
- [ ] 更新所有角色的 card.md(当前阶段字段)
|
||||
- [ ] 更新 ROADMAP.md(阶段进度条)
|
||||
- [ ] 生成上一阶段的 completion.md
|
||||
- [ ] 产出阶段复盘(docs/share/phase-NN/)
|
||||
- [ ] 审计 token 预算
|
||||
@@ -0,0 +1,6 @@
|
||||
# 架构提示词模板
|
||||
|
||||
| 文件 | 用途 |
|
||||
|------|------|
|
||||
| `architecture-design.md` | 系统架构设计模板 |
|
||||
| `technical-evaluation.md` | 技术选型评估模板 |
|
||||
@@ -0,0 +1,44 @@
|
||||
# 系统架构设计模板
|
||||
|
||||
## 输入
|
||||
|
||||
- 产品需求文档 (PRD)
|
||||
- 技术约束(已有技术栈、团队能力)
|
||||
- 非功能性需求(性能、安全、可扩展性)
|
||||
|
||||
## 输出结构
|
||||
|
||||
### 1. 架构概述
|
||||
- 一句话描述架构核心思路
|
||||
- 系统边界和范围
|
||||
|
||||
### 2. 架构图(文字描述 + ASCII)
|
||||
- 模块划分和职责
|
||||
- 模块间通信方式
|
||||
- 数据流向
|
||||
|
||||
### 3. 技术选型
|
||||
- 每个模块的技术栈及理由
|
||||
- 对比方案及淘汰原因
|
||||
- 风险点和缓解措施
|
||||
|
||||
### 4. 接口设计
|
||||
- 模块间接口定义
|
||||
- API 契约(请求/响应格式)
|
||||
- 数据模型概要
|
||||
|
||||
### 5. 非功能性设计
|
||||
- 性能目标及实现策略
|
||||
- 安全设计(认证、授权、数据保护)
|
||||
- 可扩展性考虑
|
||||
|
||||
### 6. 部署架构
|
||||
- 运行环境
|
||||
- 服务拓扑
|
||||
- CI/CD 流程
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 架构文档面向 Arch AI 和 Dev AI,不要写人类才需要的背景介绍
|
||||
- 决策必须写理由,方便后续 AI 理解为什么这样设计
|
||||
- 每个模块标注影响范围(HIGH/MEDIUM/LOW),供 QA AI 确定回归测试范围
|
||||
@@ -0,0 +1,41 @@
|
||||
# 技术选型评估模板
|
||||
|
||||
## 输入
|
||||
|
||||
- 需要解决的技术问题
|
||||
- 约束条件(预算、时间、团队、已有技术栈)
|
||||
|
||||
## 输出结构
|
||||
|
||||
### 1. 需求描述
|
||||
- 要解决什么问题
|
||||
- 关键约束是什么
|
||||
|
||||
### 2. 候选方案(2-4 个)
|
||||
|
||||
每个方案描述:
|
||||
- 方案名称和简介
|
||||
- 优势(3-5 条)
|
||||
- 劣势(3-5 条)
|
||||
- 与本项目技术栈的兼容度
|
||||
|
||||
### 3. 评估维度
|
||||
|
||||
| 维度 | 权重 | 方案A | 方案B | 方案C |
|
||||
|------|------|-------|-------|-------|
|
||||
| 性能 | 30% | — | — | — |
|
||||
| 生态成熟度 | 25% | — | — | — |
|
||||
| 学习曲线 | 20% | — | — | — |
|
||||
| 社区活跃度 | 15% | — | — | — |
|
||||
| 团队熟悉度 | 10% | — | — | — |
|
||||
| **加权总分** | 100% | — | — | — |
|
||||
|
||||
### 4. 推荐方案
|
||||
- 推荐哪个、为什么
|
||||
- 主要风险
|
||||
- 如果失败,备选方案是什么
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 评估维度可调整,但必须说明理由
|
||||
- 不追求"最优",追求"最适合当前阶段"
|
||||
@@ -0,0 +1,26 @@
|
||||
# AI 角色工作台
|
||||
|
||||
每个角色有一个独立的工作台目录。AI 每天进来只需读自己的工作台。
|
||||
|
||||
## 使用方式
|
||||
|
||||
```
|
||||
1. 读 card.md → 我是谁、我能写哪、当前阶段(< 1K tokens)
|
||||
2. 读 today.md → 今天干什么、任务优先级(< 1K tokens)
|
||||
3. 需要细节 → 按链接按需加载
|
||||
4. 完成后 → 更新 today.md,写 journal
|
||||
```
|
||||
|
||||
## 三个角色
|
||||
|
||||
| 角色 | 目录 | 职责 |
|
||||
|------|------|------|
|
||||
| Arch AI | `arch/` | 需求分析、架构设计、技术选型、跨模块协调 |
|
||||
| Dev AI | `dev/` | 编码实现、文档编写、Bug 修复 |
|
||||
| QA AI | `qa/` | 测试编写、测试执行、质量反馈 |
|
||||
|
||||
## 维护规则
|
||||
|
||||
- Arch AI 负责分配任务到各角色的 queue.md 和 today.md
|
||||
- 每个 AI 完成工作后更新自己的 today.md
|
||||
- 阶段切换时 Arch AI 更新所有 card.md
|
||||
@@ -0,0 +1,34 @@
|
||||
# Arch AI — 架构师
|
||||
|
||||
## 身份
|
||||
|
||||
我是架构 AI。负责需求分析、架构设计、技术选型、跨模块协调。
|
||||
拥有最高 AI 权限,指导 Dev AI 和 QA AI 的工作。
|
||||
|
||||
## 权限
|
||||
|
||||
**可写**: docs/ shared/ projects/*/src/ projects/*/docs/ review/*/acceptance.md review/*/impact.md review/*/task.md tools/ data/
|
||||
**只读**: .ai/ projects/*/tests/ reports/ review/*/feedback/
|
||||
**禁止**: 无
|
||||
|
||||
## 当前阶段
|
||||
|
||||
Phase 1: 基础搭建 — `.ai/phases/phase-01-foundation/goal.md`
|
||||
|
||||
## 核心交付物
|
||||
|
||||
- 产品需求文档 (PRD)
|
||||
- 系统架构设计文档
|
||||
- 技术选型评估
|
||||
- 验收标准定义
|
||||
- 变更影响评估
|
||||
- 跨模块协调
|
||||
|
||||
## 协作文件
|
||||
|
||||
- 任务分配: `.ai/roles/{dev,qa}/queue.md`
|
||||
- 代码规范: `.ai/prompts/coding/code-style.md`
|
||||
- 完整权限: `AGENTS.md`
|
||||
- 阶段上下文: `.ai/phases/phase-01-foundation/`
|
||||
- 知识沉淀: `.ai/knowledge/`
|
||||
- 全局视野: `ROADMAP.md`
|
||||
@@ -0,0 +1,18 @@
|
||||
# Arch AI · 任务队列
|
||||
|
||||
## 当前阶段 (Phase 1) 任务
|
||||
|
||||
| # | 任务 | 优先级 | 状态 | 依赖 |
|
||||
|---|------|--------|------|------|
|
||||
| 1 | 信息架构重构 | P0 | DOING | — |
|
||||
| 2 | 错题本 PRD 编写 | P0 | TODO | 1 |
|
||||
| 3 | 系统架构设计 | P1 | TODO | 2 |
|
||||
| 4 | P01 文档改写 | P1 | TODO | 2 |
|
||||
| 5 | 架构提示词模板 | P2 | TODO | — |
|
||||
|
||||
## 未来阶段预留
|
||||
|
||||
| # | 任务 | 阶段 | 优先级 |
|
||||
|---|------|------|--------|
|
||||
| — | Phase 2 MVP 架构设计 | 2 | — |
|
||||
| — | Phase 3 功能迭代架构 | 3 | — |
|
||||
@@ -0,0 +1,22 @@
|
||||
# Arch AI · 今日任务 · 2026-05-25
|
||||
|
||||
## 进行中
|
||||
|
||||
- [ ] 信息架构重构 — 正在实施
|
||||
|
||||
## 待办(按优先级)
|
||||
|
||||
1. **[P0]** 完成信息架构重构(所有文件创建 + 改写)
|
||||
2. **[P0]** 编写 `docs/01_产品需求/PRD.md` — 错题本产品需求文档
|
||||
3. **[P0]** 将 P01 项目文档从"代码检测"重写为"错题本"
|
||||
4. **[P1]** 设计 `docs/02_系统架构/` — 系统架构文档
|
||||
5. **[P1]** 补充 `.ai/prompts/architecture/` 提示词模板
|
||||
|
||||
## 已完成
|
||||
|
||||
- [x] 分析项目现状,识别架构问题
|
||||
- [x] 输出信息架构重构方案
|
||||
|
||||
## 阻塞
|
||||
|
||||
(无外部阻塞)
|
||||
@@ -0,0 +1,31 @@
|
||||
# Dev AI — 开发者
|
||||
|
||||
## 身份
|
||||
|
||||
我是开发 AI。负责编写业务代码、技术文档、Bug 修复。
|
||||
不修改测试代码和测试报告。
|
||||
|
||||
## 权限
|
||||
|
||||
**可写**: projects/*/src/ projects/*/docs/ docs/ tools/ data/ shared/ review/*/acceptance.md review/*/impact.md
|
||||
**只读**: review/*/task.md review/*/feedback/
|
||||
**禁止**: projects/*/tests/ reports/
|
||||
|
||||
## 当前阶段
|
||||
|
||||
Phase 1: 基础搭建 — `.ai/phases/phase-01-foundation/goal.md`
|
||||
|
||||
## 核心交付物
|
||||
|
||||
- 业务代码实现 (projects/*/src/)
|
||||
- 项目文档 (projects/*/docs/)
|
||||
- 验收标准补充
|
||||
- 变更影响评估
|
||||
|
||||
## 协作文件
|
||||
|
||||
- 代码规范: `.ai/prompts/coding/code-style.md`
|
||||
- 文档模板: `.ai/prompts/coding/doc-template.md`
|
||||
- 完整权限: `AGENTS.md`
|
||||
- 阶段上下文: `.ai/phases/phase-01-foundation/`
|
||||
- 全局视野: `ROADMAP.md`
|
||||
@@ -0,0 +1,17 @@
|
||||
# Dev AI · 任务队列
|
||||
|
||||
## 当前阶段 (Phase 1) 可执行任务
|
||||
|
||||
| # | 任务 ID | 项目 | 描述 | 优先级 | 状态 |
|
||||
|---|---------|------|------|--------|------|
|
||||
| 1 | P03-001 | Web | 项目初始化 | LOW | TODO |
|
||||
| 2 | CROSS-001 | 共享 | 共享工具库更新 | HIGH | TODO |
|
||||
| 3 | P01-001 | App | 用户登录 | HIGH | TODO |
|
||||
| 4 | P01-002 | App | 代码分析 API | MEDIUM | TODO |
|
||||
| 5 | P02-001 | 训练 | 数据预处理 | MEDIUM | TODO |
|
||||
|
||||
## 任务详情
|
||||
|
||||
每个任务的详细描述 → `review/active/{任务ID}/task.md`
|
||||
验收标准 → `review/active/{任务ID}/acceptance.md`
|
||||
影响范围 → `review/active/{任务ID}/impact.md`
|
||||
@@ -0,0 +1,24 @@
|
||||
# Dev AI · 今日任务 · 2026-05-25
|
||||
|
||||
## 进行中
|
||||
|
||||
(无)
|
||||
|
||||
## 待领取(按优先级)
|
||||
|
||||
| # | 任务 | 来源 | 说明 |
|
||||
|---|------|------|------|
|
||||
| 1 | P03-001 | `review/active/P03-001/` | Web 项目初始化(无依赖,可立即开始) |
|
||||
| 2 | CROSS-001 | `review/active/CROSS-001/` | 共享工具库更新(等待已有 bug 修复) |
|
||||
|
||||
## 暂不可领(等待 Arch AI)
|
||||
|
||||
| # | 任务 | 阻塞原因 |
|
||||
|---|------|----------|
|
||||
| 1 | P01-001 用户登录 | 等待 PRD |
|
||||
| 2 | P01-002 代码分析API | 等待 PRD |
|
||||
| 3 | P02-001 数据预处理 | 等待 PRD |
|
||||
|
||||
## 已完成
|
||||
|
||||
(无)
|
||||
@@ -0,0 +1,30 @@
|
||||
# QA AI — 测试者
|
||||
|
||||
## 身份
|
||||
|
||||
我是测试 AI。负责编写测试用例、执行测试、提交反馈。
|
||||
不修改业务代码。
|
||||
|
||||
## 权限
|
||||
|
||||
**可写**: projects/*/tests/ reports/ review/*/acceptance.md review/*/feedback/
|
||||
**只读**: projects/*/src/ projects/*/docs/ docs/ data/ shared/ review/*/task.md
|
||||
**禁止**: .ai/ tools/ review/*/impact.md
|
||||
|
||||
## 当前阶段
|
||||
|
||||
Phase 1: 基础搭建 — `.ai/phases/phase-01-foundation/goal.md`
|
||||
|
||||
## 核心交付物
|
||||
|
||||
- 测试用例 (projects/*/tests/)
|
||||
- 测试报告 (reports/)
|
||||
- Bug 反馈 (review/*/feedback/)
|
||||
- 验收标准补充
|
||||
|
||||
## 协作文件
|
||||
|
||||
- Bug 报告模板: `.ai/prompts/testing/bug-report.md`
|
||||
- 完整权限: `AGENTS.md`
|
||||
- 阶段上下文: `.ai/phases/phase-01-foundation/`
|
||||
- 全局视野: `ROADMAP.md`
|
||||
@@ -0,0 +1,19 @@
|
||||
# QA AI · 任务队列
|
||||
|
||||
## 当前阶段 (Phase 1)
|
||||
|
||||
暂无测试任务。所有活跃任务处于 TODO 状态。
|
||||
|
||||
## 测试流程
|
||||
|
||||
1. 确认任务已进入 REVIEW 状态(见 ROADMAP.md)
|
||||
2. 读取 `review/active/{任务ID}/task.md` — 理解任务
|
||||
3. 读取 `review/active/{任务ID}/acceptance.md` — 确认验收标准
|
||||
4. 读取 `review/active/{任务ID}/impact.md` — 了解影响范围
|
||||
5. 在 `projects/{项目}/tests/` 编写测试
|
||||
6. 执行测试,生成报告到 `reports/`
|
||||
7. 提交反馈到 `review/active/{任务ID}/feedback/`
|
||||
|
||||
## 已完成的测试
|
||||
|
||||
(无)
|
||||
@@ -0,0 +1,18 @@
|
||||
# QA AI · 今日任务 · 2026-05-25
|
||||
|
||||
## 进行中
|
||||
|
||||
(无)
|
||||
|
||||
## 待执行
|
||||
|
||||
当前没有进入 REVIEW 状态的任务,暂无测试任务。
|
||||
|
||||
## 已完成
|
||||
|
||||
(无)
|
||||
|
||||
## 说明
|
||||
|
||||
等待 Dev AI 完成代码开发后,任务状态转为 REVIEW 时开始测试工作。
|
||||
关注 `ROADMAP.md` 中的 DOING 列,当有任务进入 REVIEW 时立即介入。
|
||||
Reference in New Issue
Block a user