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:
@@ -1,6 +1,46 @@
|
||||
# ErrLens AI 编程项目
|
||||
# ErrLens
|
||||
|
||||
一个"人+3AI"协作模式的 AI 辅助编程项目仓库。
|
||||
一个"人+3AI"协作模式的 AI 编程项目。学生错题本应用(小程序 + AI 训练 + Web 后台)。
|
||||
|
||||
---
|
||||
|
||||
## 快速入口
|
||||
|
||||
| 入口 | 谁看 | 说明 |
|
||||
|------|------|------|
|
||||
| [DASHBOARD.md](DASHBOARD.md) | 人类 | 30 秒了解项目全貌 |
|
||||
| [ROADMAP.md](ROADMAP.md) | 人类 + AI | 阶段进度 + 任务看板 |
|
||||
| [docs/share/](docs/share/) | 所有人 | 项目开发过程全记录 |
|
||||
| [.ai/roles/](.ai/roles/) | AI | 角色工作台(每个 AI 的入口) |
|
||||
|
||||
---
|
||||
|
||||
## 团队角色
|
||||
|
||||
| 角色 | 是谁 | 干什么 |
|
||||
|------|------|--------|
|
||||
| 人类负责人 | 你 | 需求、审阅、决策、验收 |
|
||||
| Arch AI | AI 模型 | 需求分析、架构设计、跨模块协调 |
|
||||
| Dev AI | AI 模型 | 写代码、写文档、修 Bug |
|
||||
| QA AI | AI 模型 | 写测试、跑测试、写反馈 |
|
||||
|
||||
角色详情:[AGENTS.md](AGENTS.md)
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd errlens
|
||||
|
||||
# 安装前端依赖
|
||||
pnpm install
|
||||
|
||||
# 启动 P01 开发服务器
|
||||
cd projects/P01_errlens_app
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -8,161 +48,41 @@
|
||||
|
||||
```
|
||||
.
|
||||
├── AGENTS.md # AI角色定义+权限约定+工作流
|
||||
├── README.md
|
||||
├── .gitignore
|
||||
├── .ai/ # AI协作核心配置
|
||||
│ ├── config/
|
||||
│ │ ├── architect.json # Arch AI 配置
|
||||
│ │ ├── coder.json # Dev AI 配置
|
||||
│ │ ├── tester.json # QA AI 配置
|
||||
│ │ └── workflow.json # 工作流配置
|
||||
│ └── prompts/
|
||||
│ ├── architecture/ # 架构设计提示词模板
|
||||
│ ├── coding/ # 编码提示词模板
|
||||
│ └── testing/ # 测试提示词模板
|
||||
├── docs/ # 项目级总体文档
|
||||
├── DASHBOARD.md # 人类仪表盘
|
||||
├── ROADMAP.md # 路线图看板
|
||||
├── AGENTS.md # AI 角色 + 权限
|
||||
├── ENVIRONMENT.md # 开发环境
|
||||
├── .ai/ # AI 协作核心
|
||||
│ ├── roles/ # 角色工作台(AI 日常入口)
|
||||
│ ├── phases/ # 阶段上下文
|
||||
│ ├── knowledge/ # 知识沉淀
|
||||
│ ├── prompts/ # 提示词模板
|
||||
│ └── config/ # 角色配置
|
||||
├── docs/ # 项目文档
|
||||
│ ├── 01_产品需求/
|
||||
│ ├── 02_系统架构/
|
||||
│ ├── 03_开发规范/
|
||||
│ ├── 04_部署运维/
|
||||
│ ├── 05_变更日志/
|
||||
│ │ └── archived/ # 历史变更日志(按年月归档)
|
||||
│ └── 06_开发日志/
|
||||
├── tools/ # 开发工具脚本
|
||||
├── data/ # 训练数据
|
||||
├── projects/ # 项目代码
|
||||
│ ├── P01_errlens_app/ # 主应用项目
|
||||
│ │ ├── src/ # 业务代码 (Dev AI)
|
||||
│ │ ├── tests/ # 测试代码 (QA AI)
|
||||
│ │ ├── docs/ # 项目文档 (Dev AI)
|
||||
│ │ │ ├── 01_需求概要.md
|
||||
│ │ │ ├── 02_架构设计.md
|
||||
│ │ │ └── 03_接口定义.md
|
||||
│ │ └── ENVIRONMENT.md # 项目级环境准备
|
||||
│ └── P02_errlens_training/ # AI训练项目
|
||||
│ ├── src/
|
||||
│ ├── tests/
|
||||
│ ├── docs/
|
||||
│ │ ├── 01_需求概要.md
|
||||
│ │ ├── 02_架构设计.md
|
||||
│ │ └── 03_训练流程.md
|
||||
│ └── ENVIRONMENT.md
|
||||
├── review/ # 交接中心
|
||||
│ ├── active/ # 活跃任务
|
||||
│ │ ├── P01-001/ # 项目1-任务001
|
||||
│ │ │ ├── task.md # 任务描述
|
||||
│ │ │ ├── acceptance.md # 验收标准
|
||||
│ │ │ ├── impact.md # 变更影响范围
|
||||
│ │ │ └── feedback/ # 反馈记录
|
||||
│ │ │ └── round1.md
|
||||
│ │ ├── P01-002/ # 项目1-任务002
|
||||
│ │ ├── P02-001/ # 项目2-任务001
|
||||
│ │ └── CROSS-001/ # 跨项目任务
|
||||
│ └── archived/ # 已完成任务(按季度归档)
|
||||
│ ├── 2026-Q2/
|
||||
│ └── 2026-Q3/
|
||||
├── shared/ # 共享资源
|
||||
│ ├── scripts/ # 共享脚本
|
||||
│ ├── templates/ # 代码/文档模板
|
||||
│ └── utils/ # 工具函数
|
||||
├── reports/ # 统一报告
|
||||
│ ├── test-results/ # 测试结果
|
||||
│ └── quality-reports/ # 质量评审报告
|
||||
└── .github/ # CI/CD配置
|
||||
└── workflows/
|
||||
│ ├── share/ # 对外分享内容
|
||||
│ └── ...
|
||||
├── projects/ # 代码
|
||||
│ ├── P01_errlens_app/
|
||||
│ ├── P02_errlens_training/
|
||||
│ └── P03_errlens_web/
|
||||
├── review/ # 任务交接
|
||||
│ └── active/ # 活跃任务
|
||||
├── shared/ # 共享资源
|
||||
└── tools/ # 开发工具
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 团队角色
|
||||
|
||||
| 角色 | 是谁 | 干什么 | 不干什么 |
|
||||
|------|------|--------|----------|
|
||||
| **人类负责人** | 你 | 下指令、审阅、做决策、定验收标准 | 不写代码、不写测试 |
|
||||
| **Arch AI** | Claude/TRAE/元宝等 | 需求分析、架构设计、技术选型、跨模块协调 | 不写测试 |
|
||||
| **Dev AI** | Claude/TRAE/元宝等 | 写业务代码+文档、修bug、写impact | 不动tests/、不跑测试 |
|
||||
| **QA AI** | 扣子编程AI | 写测试、跑测试、写反馈 | 不动src/、不改业务代码 |
|
||||
|
||||
---
|
||||
|
||||
## 工作流程
|
||||
|
||||
1. **Arch AI** 分析需求,输出 `docs/01_产品需求/PRD.md` 和 `review/active/P01-001/task.md`
|
||||
2. **Arch AI** 设计架构,输出 `docs/02_系统架构/`、`acceptance.md`、`impact.md`
|
||||
3. **Dev AI** 在 `projects/P01_errlens_app/src/` 写代码,在 `docs/` 写文档
|
||||
4. **你**审一眼,没问题就触发QA AI
|
||||
5. **QA AI** 读 `task.md` + `acceptance.md` + `impact.md`,按 `ENVIRONMENT.md` 准备环境,在 `tests/` 写测试并执行,写 `feedback/round1.md`
|
||||
6. **有bug** → 你看反馈 → 让Dev AI修 → 回到步骤3(round2)
|
||||
**通过** → 你确认 → 任务关闭,报告归档到 `reports/`
|
||||
|
||||
---
|
||||
|
||||
## 可用 Skill
|
||||
|
||||
| Skill | 功能 | 触发词 |
|
||||
|-------|------|--------|
|
||||
| **ai-collab-setup** | 创建协作框架 | 初始化项目时 |
|
||||
| **add-subproject** | 添加子项目 | 新增子项目时 |
|
||||
| **resume-context** | 换电脑时同步上下文 | `接着干 开发/测试/架构` |
|
||||
| **switch-model** | 换大模型时同步上下文 | `切换模型 架构/开发/测试` |
|
||||
| **update-constitution** | 更新宪法文件 | AI 角色/权限/工作流变更时 |
|
||||
| **update-docs** | 更新项目文档 | 代码/结构变更后 |
|
||||
| **git** | 封装 git 操作 | 提交/推送/分支管理时 |
|
||||
|
||||
---
|
||||
|
||||
## 任务状态流转
|
||||
|
||||
```
|
||||
TODO → IN_PROGRESS → REVIEW → DONE → ARCHIVED(移入archived/季度目录)
|
||||
```
|
||||
|
||||
`task.md` 中添加状态字段:
|
||||
```
|
||||
status: TODO | IN_PROGRESS | REVIEW | DONE | ARCHIVED
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 决策总结
|
||||
|
||||
| 问题 | 决策 |
|
||||
|------|------|
|
||||
| 任务创建 | 先手动,中期脚本化(create-task.sh),后期CI联动Issue |
|
||||
| 跨项目任务 | `CROSS-xxx/`,feedback按项目分文件(如 `P01-round1.md`) |
|
||||
| 任务归档 | `review/active/` + `review/archived/2026-Qx/`,状态字段驱动,定期归档 |
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone <repository-url>
|
||||
cd errlens
|
||||
|
||||
# 查看目录结构
|
||||
find . -type d | sort
|
||||
|
||||
# 查看当前任务
|
||||
ls -la review/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 参考文档
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [AGENTS.md](AGENTS.md) | AI角色定义与权限约定 |
|
||||
| [workflow.json](.ai/config/workflow.json) | 工作流配置 |
|
||||
| [P01-001 任务](review/P01-001/task.md) | 示例任务单 |
|
||||
|
||||
---
|
||||
|
||||
## 版本历史
|
||||
|
||||
| 版本 | 日期 | 说明 |
|
||||
|------|------|------|
|
||||
| v1.0 | 2026-05-22 | 初始版本,完成目录结构设计 |
|
||||
| Skill | 功能 |
|
||||
|-------|------|
|
||||
| resume-context | 换电脑时同步上下文 |
|
||||
| switch-model | 换大模型时同步上下文 |
|
||||
| update-constitution | 更新 AI 角色/权限/工作流 |
|
||||
| update-docs | 代码变更后同步文档 |
|
||||
| git | 封装 git 操作 |
|
||||
| ai-collab-setup | 初始化协作框架 |
|
||||
| add-subproject | 添加子项目 |
|
||||
|
||||
Reference in New Issue
Block a user