hwd32/ai_soc_sw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(context): 新增 resume-context Skill 和项目上下文文档体系

Browse Source 
- 新增 resume-context Skill（接着干）- 换电脑时自动同步上下文
- 新增 docs/PROJECT_CONTEXT.md 项目整体上下文
- 新增 docs/DECISIONS.md 架构决策记录（ADR）
- 新增 docs/06_开发日志/ 按日期记录讨论内容
- 新增根目录 ENVIRONMENT.md 开发环境配置
- 更新 ai-collab-setup/SKILL.md 版本升至 v2.2
This commit is contained in:
hwd32
2026-05-23 21:53:05 +08:00
parent 456cda909b
commit 9f493c12f9
7 changed files with 560 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/06_开发日志/2026-05-23_框架搭建.md
+57
View File
@@ -0,0 +1,57 @@
# 2026-05-23_框架搭建
## 讨论内容
用户是嵌入式 MCU 软件开发者，个人团队开发错题本项目。需求包括：
1. 学生错题本小程序（跨平台，微信优先）
2. Web 管理后台（给老师和机构用）
3. 数据训练算法（错题分析和推荐）
4. 数据飞轮思维（数据采集 → AI 分析 → 个性化推荐）
用户在家和单位两台电脑间切换开发，需要上下文同步机制。
## 关键决策
1. **采用"1 人 + 2AI"协作框架** - Dev AI 编码 + QA AI 测试
2. **R/W/RW/- 四态权限体系** - 比二元权限更灵活
3. **项目级文档放在根目录 docs/** - 不属于任何子项目
4. **新增 tools/ 和 data/ 目录** - 开发工具和训练数据独立管理
5. **工作流增加 retry 和 escalation 机制** - 自动处理 Bug 修复循环
6. **创建 resume-context Skill** - 解决多电脑切换时的上下文同步
## 完成的工作
### 框架搭建
- ✅ 创建完整目录结构
- ✅ 编写 AGENTS.md（AI 角色和权限约定）
- ✅ 创建 AI 配置文件（coder.json、tester.json、workflow.json）
- ✅ 创建提示词模板（code-style.md、doc-template.md、bug-report.md）
### Skill 工具
- ✅ ai-collab-setup - 一键创建协作框架
- ✅ add-subproject - 动态添加子项目
- ✅ resume-context - 上下文同步（接着干）
### 文档体系
- ✅ docs/PROJECT_CONTEXT.md - 项目整体上下文
- ✅ docs/DECISIONS.md - 架构决策记录
- ✅ docs/06_开发日志/ - 开发日志目录
### 目录新增
- ✅ docs/ - 项目级总体文档（5 个子目录）
- ✅ tools/ - 开发工具脚本
- ✅ data/ - 训练数据
## 待办事项
1. [ ] 完成产品需求文档（PRD）
2. [ ] 完成系统架构设计
3. [ ] 启动 P01_errlens_app 小程序开发
4. [ ] 设计数据采集方案
5. [ ] 规划 Web 管理后台功能
## 备注
- 用户是嵌入式开发者，对前端/AI 框架不熟悉，需要 AI 多承担技术选型工作
- Web 管理后台功能尚未确定，先简化设计，保持可扩展性
- 用户有一些数据但不够，需要数据飞轮思维
docs/06_开发日志/README.md
+18
View File
@@ -0,0 +1,18 @@
# 开发日志索引
## 使用说明
按日期记录开发讨论内容，格式：`YYYY-MM-DD_主题.md`
## 日志列表
| 日期 | 主题 | 文件 |
|------|------|------|
| 2026-05-23 | 框架搭建 | [2026-05-23_框架搭建.md](./2026-05-23_框架搭建.md) |
## 如何添加新日志
1. 在 `docs/06_开发日志/` 下创建新文件
2. 命名格式：`YYYY-MM-DD_主题.md`
3. 参考 [2026-05-23_框架搭建.md](./2026-05-23_框架搭建.md) 的格式
4. 更新本索引
docs/DECISIONS.md
+154
View File
@@ -0,0 +1,154 @@
# 架构决策记录 (ADR)
## 什么是 ADR？
ADR（Architecture Decision Record）记录项目中重要的架构决策及其原因。当新成员（或 AI）加入时，可以通过 ADR 快速理解"为什么这么做"。
## 决策记录
### ADR-001: 采用"1 人 + 2AI"协作框架
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
项目需要高效开发，但团队只有 1 人。利用 AI 辅助编程可以大幅提升效率。
**决策**:
采用 1 个负责人 + 2 个 AI（Dev AI 编码 + QA AI 测试）的协作模式。
**后果**:
- ✅ 开发效率大幅提升
- ✅ 代码质量有保障（独立测试 AI）
- ⚠️ 需要维护权限体系和协作流程
- ⚠️ 人类需要审阅 AI 输出
---
### ADR-002: 采用 R/W/RW/- 四态权限体系
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
初始框架使用简单的 allowed/forbidden 二元权限，无法满足"只读"场景。
**决策**:
采用四态权限：`-`（无权）、`R`（只读）、`W`（可写）、`RW`（读写）。
**后果**:
- ✅ 更细粒度的权限控制
- ✅ 明确只读路径（如 task.md、feedback/）
- ⚠️ 权限矩阵更复杂，需要维护
---
### ADR-003: 项目级文档放在根目录 docs/
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
项目级文档（产品需求、架构设计等）不属于任何子项目，需要独立存放。
**决策**:
在根目录创建 `docs/` 目录，而非 `projects/P00_DOCS/`。
**后果**:
- ✅ 语义清晰，业界标准
- ✅ 路径简短
- ⚠️ 需要在权限矩阵中单独定义
---
### ADR-004: 新增 tools/ 和 data/ 目录
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
开发工具脚本和训练数据需要独立管理，不应混入项目代码。
**决策**:
在根目录创建 `tools/`（开发工具）和 `data/`（训练数据）。
**权限**:
- `tools/`: Dev AI 可写，QA AI 禁止
- `data/`: Dev AI 可写，QA AI 只读
**后果**:
- ✅ 职责分离，便于管理
- ✅ 训练数据独立于代码
- ⚠️ 需要维护数据版本
---
### ADR-005: 工作流增加 retry 和 escalation 机制
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
线性工作流无法处理测试失败的情况。
**决策**:
- 增加 retry 机制：最多 3 轮测试修复循环
- 增加 escalation 机制：第 3 轮仍有 BLOCKER/HIGH 时升级给人类
**后果**:
- ✅ 自动处理常见 Bug 修复
- ✅ 严重问题及时升级
- ⚠️ 需要维护修复轮次计数
---
### ADR-006: 创建 resume-context Skill 解决多电脑同步
**日期**: 2026-05-23
**状态**: 已采纳
**决策者**: 人类负责人
**背景**:
用户在家和单位两台电脑间切换，需要快速恢复开发上下文。
**决策**:
- 创建 `resume-context` Skill
- 创建 `docs/PROJECT_CONTEXT.md` 项目上下文
- 创建 `docs/06_开发日志/` 按日期记录讨论
**后果**:
- ✅ 换电脑后快速恢复上下文
- ✅ 新 AI 对话可以读取背景
- ⚠️ 需要维护文档更新
---
## 决策模板
```markdown
### ADR-XXX: 决策标题
**日期**: YYYY-MM-DD
**状态**: 考虑中 / 已采纳 / 已废弃
**决策者**: XXX
**背景**:
[为什么需要做这个决策]
**决策**:
[具体决定是什么]
**后果**:
- ✅ 好处
- ⚠️ 需要注意的点
```
---
**最后更新**: 2026-05-23
**维护者**: 人类负责人 + Dev AI
docs/PROJECT_CONTEXT.md
+112
View File
@@ -0,0 +1,112 @@
# 项目上下文 - ErrLens 错题本
## 项目愿景
打造跨平台的学生错题本应用，配套 Web 管理后台和数据训练算法，形成"数据采集 → AI 分析 → 个性化推荐"的数据飞轮。
## 当前阶段
**框架搭建阶段**（2026-05-23 完成）
已完成：
- ✅ "1 人 + 2AI（Dev AI + QA AI）"协作框架
- ✅ 完整目录结构和权限体系（R/W/RW/- 四态）
- ✅ AI 配置文件（coder.json、tester.json、workflow.json）
- ✅ 提示词模板（code-style.md、doc-template.md、bug-report.md）
- ✅ Skill 工具（ai-collab-setup、add-subproject、resume-context）
- ✅ 项目级文档目录（docs/、tools/、data/）
待启动：
- ⏳ P01_errlens_app 小程序开发
- ⏳ P02_errlens_training 数据训练算法
- ⏳ P03_errlens_web Web 管理后台
## 技术栈
| 层级 | 技术选型 | 说明 |
|------|---------|------|
| 小程序 | Taro + React + TypeScript | 跨平台（微信优先，预留支付宝/抖音） |
| Web 管理 | Next.js + React + TypeScript | SSR，便于 SEO 和性能 |
| 后端 | NestJS + TypeScript | 统一语言，便于维护 |
| 数据库 | PostgreSQL | 关系型数据，支持复杂查询 |
| AI 训练 | Python + PyTorch | 错题分析和推荐算法 |
| 包管理 | pnpm | 快速、节省磁盘空间 |
| 协作框架 | 1 人 + 2AI | Dev AI（编码）+ QA AI（测试） |
## 团队架构
```
人类负责人（唯一决策者）
├── Dev AI（编码 AI）- 编写代码、文档、影响评估
└── QA AI（测试 AI）- 编写测试、执行测试、质量保障
```
详细权限见 [AGENTS.md](../AGENTS.md)
## 关键决策
| 决策 | 原因 | 日期 |
|------|------|------|
| 采用 R/W/RW/- 四态权限体系 | 比二元权限更灵活，明确只读路径 | 2026-05-23 |
| 项目级文档放在根目录 docs/ | 不属于任何子项目，业界标准做法 | 2026-05-23 |
| 新增 tools/ 和 data/ 目录 | 开发工具和训练数据需要独立管理 | 2026-05-23 |
| 创建 resume-context Skill | 解决多电脑切换时的上下文同步问题 | 2026-05-23 |
| 工作流增加 retry 机制 | 允许最多 3 轮测试修复循环 | 2026-05-23 |
| 工作流增加 escalation 机制 | 第 3 轮仍有严重 Bug 时升级给人类 | 2026-05-23 |
## 待解决问题
1. **Web 管理后台具体功能** - 尚未确定，需要简化设计，保持可扩展性
2. **数据来源** - 用户有一些数据但不够，需要数据飞轮思维
3. **跨平台优先级** - 目前主要是微信，但框架上要考虑跨平台
4. **AI 训练算法细节** - 错题分析和推荐算法的具体实现方案
## 下一步计划
1. [ ] 完成产品需求文档（PRD）
2. [ ] 完成系统架构设计
3. [ ] 启动 P01_errlens_app 小程序开发
4. [ ] 设计数据采集方案
5. [ ] 规划 Web 管理后台功能
## 项目结构
```
errlens/
├── docs/ # 项目级总体文档
│ ├── 01_产品需求/
│ ├── 02_系统架构/
│ ├── 03_开发规范/
│ ├── 04_部署运维/
│ ├── 05_变更日志/
│ └── 06_开发日志/
├── tools/ # 开发工具脚本
├── data/ # 训练数据
├── projects/ # 子项目
│ ├── P01_errlens_app/ # 错题本小程序
│ ├── P02_errlens_training/# 数据训练算法
│ └── P03_errlens_web/ # Web 管理后台
├── review/ # 任务交接中心
├── reports/ # 测试/质量报告
├── shared/ # 共享资源
└── .ai/ # AI 协作配置
```
## 开发环境
- **操作系统**: Windows / macOS / Linux（跨平台开发）
- **IDE**: Trae CN
- **Node.js**: >= 20.x
- **包管理器**: pnpm >= 9.0.0
- **Python**: >= 3.10（AI 训练）
## 同步机制
- **代码同步**: Git（远程仓库：GitCode）
- **上下文同步**: `docs/PROJECT_CONTEXT.md` + `docs/06_开发日志/`
- **恢复上下文**: 使用 `resume-context` Skill
---
**最后更新**: 2026-05-23
**维护者**: 人类负责人 + Dev AI