Files
ai_soc_sw/README.md
T

154 lines
5.6 KiB
Markdown
Raw Normal View History

# ErrLens AI 编程项目
一个"人+3AI"协作模式的 AI 辅助编程项目仓库。
---
## 目录结构
```
.
├── 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/ # 项目级总体文档
│ ├── 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/
```
---
## 团队角色
| 角色 | 是谁 | 干什么 | 不干什么 |
|------|------|--------|----------|
| **人类负责人** | 你 | 下指令、审阅、做决策、定验收标准 | 不写代码、不写测试 |
| **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修 → 回到步骤3round2
**通过** → 你确认 → 任务关闭,报告归档到 `reports/`
---
## 任务状态流转
```
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 | 初始版本,完成目录结构设计 |