aigroup-workflow 2.2.1 → 2.2.3

package/docs/templates/ai-project-final.md

@@ -1,124 +1,124 @@
-# AI项目适配文档模板
-
-> 放置位置: `项目根目录/.claude/project.md`
-> 提交到git，团队共享
-
----
-
-# [项目名称]
-
-## 项目简介
-```yaml
-名称: xxx
-一句话描述: xxx
-技术栈: 前端Vue3 + 后端NestJS + MySQL
-仓库: git@xxx.git
-负责人: xxx
-```
-
-## 模块地图
-
-> AI开发时的导航表，快速定位代码位置
-
-| 业务功能 | 模块路径 | 关键文件 | 说明 |
-|----------|----------|----------|------|
-| 用户登录 | src/modules/auth/ | auth.service.ts | JWT认证 |
-| 用户管理 | src/modules/user/ | user.service.ts | CRUD |
-| 订单管理 | src/modules/order/ | order.service.ts | 状态机流转 |
-| 支付 | src/modules/payment/ | payment.service.ts | 对接微信/支付宝 |
-
-## 业务概念
-
-> AI必须理解的领域术语
-
-| 术语 | 含义 | 示例 |
-|------|------|------|
-| SKU | 库存单位 | iPhone 15 黑色 128G |
-| SPU | 商品单位 | iPhone 15 |
-
-## 数据流向
-
-```
-请求 → Controller → Service → Repository → MySQL
-                       ↓
-                   Redis缓存
-```
-
-## 禁止事项
-
-> AI绝对不能做的事
-
-- ❌ 不要修改 `src/config/prod.ts` 生产配置
-- ❌ 不要删除 `migrations/` 下的任何文件
-- ❌ 不要直接操作数据库，必须通过Repository
-- ❌ 不要在代码中硬编码密钥
-
-## 开发规范
-
-> AI写代码时遵循的规范
-
-```yaml
-语言: TypeScript strict模式
-命名:
-  - 文件: kebab-case (user-service.ts)
-  - 类: PascalCase (UserService)
-  - 方法: camelCase (findById)
-注释: 中文，关键逻辑必须注释
-错误处理: 统一抛出 BusinessException
-日志: 使用 this.logger，不要用 console.log
-```
-
-## 测试验证
-
-> 修改代码后如何验证
-
-```bash
-# 单元测试
-npm run test
-
-# E2E测试
-npm run test:e2e
-
-# 本地启动验证
-npm run dev
-# 访问 http://localhost:3000/api/health
-```
-
-## 常见问题
-
-> 踩过的坑，避免AI重复踩
-
-| 问题 | 原因 | 解决方案 |
-|------|------|----------|
-| 启动报错端口占用 | 上次没关干净 | `lsof -i:3000` 然后kill |
-| 数据库连接失败 | 没启动MySQL | `docker-compose up -d` |
-
-## 当前迭代
-
-> 当前在做什么（可选，频繁更新）
-
-```yaml
-版本: v2.3.0
-分支: feature/payment-refund
-任务:
-  - [ ] 退款功能开发
-  - [ ] 退款通知对接
-```
-
-## 变更记录
-
-> 重大变更记录（可选）
-
-### 2024-02-01
-- 新增支付模块 `src/modules/payment/`
-- 订单模块增加支付状态字段
-
----
-
-<!--
-维护指南:
-1. 模块地图、业务概念、禁止事项 → 变化少，偶尔更新
-2. 当前迭代 → 每个迭代更新一次
-3. 变更记录 → 重大变更时记录
-4. 提交到git，团队共享
--->
+# AI项目适配文档模板
+
+> 放置位置: `项目根目录/.claude/project.md`
+> 提交到git，团队共享
+
+---
+
+# [项目名称]
+
+## 项目简介
+```yaml
+名称: xxx
+一句话描述: xxx
+技术栈: 前端Vue3 + 后端NestJS + MySQL
+仓库: git@xxx.git
+负责人: xxx
+```
+
+## 模块地图
+
+> AI开发时的导航表，快速定位代码位置
+
+| 业务功能 | 模块路径 | 关键文件 | 说明 |
+|----------|----------|----------|------|
+| 用户登录 | src/modules/auth/ | auth.service.ts | JWT认证 |
+| 用户管理 | src/modules/user/ | user.service.ts | CRUD |
+| 订单管理 | src/modules/order/ | order.service.ts | 状态机流转 |
+| 支付 | src/modules/payment/ | payment.service.ts | 对接微信/支付宝 |
+
+## 业务概念
+
+> AI必须理解的领域术语
+
+| 术语 | 含义 | 示例 |
+|------|------|------|
+| SKU | 库存单位 | iPhone 15 黑色 128G |
+| SPU | 商品单位 | iPhone 15 |
+
+## 数据流向
+
+```
+请求 → Controller → Service → Repository → MySQL
+                       ↓
+                   Redis缓存
+```
+
+## 禁止事项
+
+> AI绝对不能做的事
+
+- ❌ 不要修改 `src/config/prod.ts` 生产配置
+- ❌ 不要删除 `migrations/` 下的任何文件
+- ❌ 不要直接操作数据库，必须通过Repository
+- ❌ 不要在代码中硬编码密钥
+
+## 开发规范
+
+> AI写代码时遵循的规范
+
+```yaml
+语言: TypeScript strict模式
+命名:
+  - 文件: kebab-case (user-service.ts)
+  - 类: PascalCase (UserService)
+  - 方法: camelCase (findById)
+注释: 中文，关键逻辑必须注释
+错误处理: 统一抛出 BusinessException
+日志: 使用 this.logger，不要用 console.log
+```
+
+## 测试验证
+
+> 修改代码后如何验证
+
+```bash
+# 单元测试
+npm run test
+
+# E2E测试
+npm run test:e2e
+
+# 本地启动验证
+npm run dev
+# 访问 http://localhost:3000/api/health
+```
+
+## 常见问题
+
+> 踩过的坑，避免AI重复踩
+
+| 问题 | 原因 | 解决方案 |
+|------|------|----------|
+| 启动报错端口占用 | 上次没关干净 | `lsof -i:3000` 然后kill |
+| 数据库连接失败 | 没启动MySQL | `docker-compose up -d` |
+
+## 当前迭代
+
+> 当前在做什么（可选，频繁更新）
+
+```yaml
+版本: v2.3.0
+分支: feature/payment-refund
+任务:
+  - [ ] 退款功能开发
+  - [ ] 退款通知对接
+```
+
+## 变更记录
+
+> 重大变更记录（可选）
+
+### 2024-02-01
+- 新增支付模块 `src/modules/payment/`
+- 订单模块增加支付状态字段
+
+---
+
+<!--
+维护指南:
+1. 模块地图、业务概念、禁止事项 → 变化少，偶尔更新
+2. 当前迭代 → 每个迭代更新一次
+3. 变更记录 → 重大变更时记录
+4. 提交到git，团队共享
+-->

package/docs/templates/ai-project.md

@@ -1,105 +1,105 @@
-# AI项目说明模板
-
-> 放置在项目根目录 `.claude/project.md`，AI启动时自动读取
-
----
-
-# [项目名称]
-
-## META
-```yaml
-名称: xxx
-版本: x.x.x
-更新: YYYY-MM-DD
-维护者: xxx
-```
-
-## 一句话描述
-[20字以内描述项目是什么]
-
-## 技术栈
-```yaml
-前端: Vue3 / React / ...
-后端: NestJS / Express / ...
-数据库: MySQL / MongoDB / ...
-部署: Docker / PM2 / ...
-```
-
-## 目录结构
-```
-项目根目录/
-├── src/
-│   ├── modules/       # [说明]
-│   ├── services/      # [说明]
-│   └── utils/         # [说明]
-├── tests/             # [说明]
-└── config/            # [说明]
-```
-
-## 关键文件
-<!-- AI需要重点关注的文件 -->
-
-| 文件 | 作用 | 修改频率 |
-|------|------|----------|
-| src/main.ts | 入口文件 | 低 |
-| src/config.ts | 配置中心 | 中 |
-| src/modules/user/ | 用户模块 | 高 |
-
-## 核心概念
-<!-- 项目特有的业务概念，AI必须理解 -->
-
-| 概念 | 说明 |
-|------|------|
-| xxx | xxx |
-
-## 数据流
-<!-- 简述数据如何流转 -->
-```
-用户请求 → Controller → Service → Repository → DB
-                ↓
-            返回响应
-```
-
-## 开发规范
-```yaml
-命名: 小驼峰 / 大驼峰 / 下划线
-缩进: 2空格 / 4空格
-分支: feature/xxx, fix/xxx
-提交: feat: / fix: / docs:
-```
-
-## 常用命令
-```bash
-npm run dev      # 启动开发
-npm run build    # 构建
-npm run test     # 测试
-```
-
-## 当前状态
-```yaml
-阶段: 开发中 / 测试中 / 已上线
-分支: main / develop
-最近变更: [简述]
-```
-
-## 进行中的任务
-- [ ] 任务1
-- [ ] 任务2
-
-## 已知问题
-- 问题1: [描述]
-- 问题2: [描述]
-
-## 变更记录
-### YYYY-MM-DD
-- 变更内容
-
----
-
-<!--
-使用说明：
-1. 复制此模板到项目 .claude/project.md
-2. 填写各项内容
-3. 代码变动时更新"当前状态"和"变更记录"
-4. AI启动时会自动读取此文件
--->
+# AI项目说明模板
+
+> 放置在项目根目录 `.claude/project.md`，AI启动时自动读取
+
+---
+
+# [项目名称]
+
+## META
+```yaml
+名称: xxx
+版本: x.x.x
+更新: YYYY-MM-DD
+维护者: xxx
+```
+
+## 一句话描述
+[20字以内描述项目是什么]
+
+## 技术栈
+```yaml
+前端: Vue3 / React / ...
+后端: NestJS / Express / ...
+数据库: MySQL / MongoDB / ...
+部署: Docker / PM2 / ...
+```
+
+## 目录结构
+```
+项目根目录/
+├── src/
+│   ├── modules/       # [说明]
+│   ├── services/      # [说明]
+│   └── utils/         # [说明]
+├── tests/             # [说明]
+└── config/            # [说明]
+```
+
+## 关键文件
+<!-- AI需要重点关注的文件 -->
+
+| 文件 | 作用 | 修改频率 |
+|------|------|----------|
+| src/main.ts | 入口文件 | 低 |
+| src/config.ts | 配置中心 | 中 |
+| src/modules/user/ | 用户模块 | 高 |
+
+## 核心概念
+<!-- 项目特有的业务概念，AI必须理解 -->
+
+| 概念 | 说明 |
+|------|------|
+| xxx | xxx |
+
+## 数据流
+<!-- 简述数据如何流转 -->
+```
+用户请求 → Controller → Service → Repository → DB
+                ↓
+            返回响应
+```
+
+## 开发规范
+```yaml
+命名: 小驼峰 / 大驼峰 / 下划线
+缩进: 2空格 / 4空格
+分支: feature/xxx, fix/xxx
+提交: feat: / fix: / docs:
+```
+
+## 常用命令
+```bash
+npm run dev      # 启动开发
+npm run build    # 构建
+npm run test     # 测试
+```
+
+## 当前状态
+```yaml
+阶段: 开发中 / 测试中 / 已上线
+分支: main / develop
+最近变更: [简述]
+```
+
+## 进行中的任务
+- [ ] 任务1
+- [ ] 任务2
+
+## 已知问题
+- 问题1: [描述]
+- 问题2: [描述]
+
+## 变更记录
+### YYYY-MM-DD
+- 变更内容
+
+---
+
+<!--
+使用说明：
+1. 复制此模板到项目 .claude/project.md
+2. 填写各项内容
+3. 代码变动时更新"当前状态"和"变更记录"
+4. AI启动时会自动读取此文件
+-->