feat: 新增 Codex 多 Agent 协作模板,建立项目规范与文档骨架
- 新增 .codex/skills/ 目录,包含 7 个专业角色定义:
- requirements-analyst(需求分析师)
- architect(架构分析师)
- ui-ux-designer(UI/UX 设计师)
- frontend-engineer(前端工程师)
- backend-engineer(后端工程师)
- qa-engineer(测试工程师)
- devops-engineer(运维工程师)
- 新增总控协调代理配置:
- .codex/prompts/orchestrator.md:总控提示词与工作流定义
- .codex/config.toml:Codex 项目配置
- 新增项目级协作规范:
- AGENTS.md:定义多 agent 协作规则、角色边界与推荐工作流
- 新增完整文档骨架(docs/):
- prd.md:产品需求文档模板
- user-stories.md:用户故事模板
- acceptance-criteria.md:验收标准模板
- architecture.md:架构设计模板
- api-spec.md:接口规格模板
- db-design.md:数据设计模板
- ui-ia.md:信息架构模板
- ui-flow.md:交互流程模板
- design-system.md:设计系统说明模板
- test-cases.md:测试用例模板
- deployment.md:部署说明模板
- README.md:文档目录说明
- 新增项目说明文档:
- README.md:模板仓库使用说明与推荐方式
- 配置 Git 忽略规则:
- .gitignore:覆盖常见开发环境产物与 Codex 临时文件
This commit is contained in:
21
docs/README.md
Normal file
21
docs/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# 文档目录说明
|
||||
|
||||
本目录存放项目正式文档和多 agent 工作流中的中间产物。
|
||||
|
||||
## 文档清单
|
||||
- `prd.md`:产品需求文档
|
||||
- `user-stories.md`:用户故事
|
||||
- `acceptance-criteria.md`:验收标准
|
||||
- `architecture.md`:架构设计
|
||||
- `api-spec.md`:接口规格
|
||||
- `db-design.md`:数据设计
|
||||
- `ui-ia.md`:信息架构
|
||||
- `ui-flow.md`:交互流程
|
||||
- `design-system.md`:设计系统说明
|
||||
- `test-cases.md`:测试用例
|
||||
- `deployment.md`:部署说明
|
||||
|
||||
## 使用原则
|
||||
- 这些文件是项目正式文档,不应迁移到 `.codex/`。
|
||||
- 如果仓库中已经有对应文档,应优先合并或更新,而不是重复创建。
|
||||
- 当某些模板暂时不适用时,可以保留文件,但应在内容中标记“本项目暂不适用”。
|
||||
8
docs/acceptance-criteria.md
Normal file
8
docs/acceptance-criteria.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# 验收标准
|
||||
|
||||
## AC-001
|
||||
- 功能或故事引用:待补充
|
||||
- 可测试验收标准:待补充
|
||||
- 边界情况:待补充
|
||||
- 失败状态:待补充
|
||||
- 超出范围说明:待补充
|
||||
12
docs/api-spec.md
Normal file
12
docs/api-spec.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# 接口规格
|
||||
|
||||
## 接口模板
|
||||
### 接口名称
|
||||
- 用途:待补充
|
||||
- 请求方法:待补充
|
||||
- 路径:待补充
|
||||
- 认证要求:待补充
|
||||
- 请求结构:待补充
|
||||
- 响应结构:待补充
|
||||
- 错误场景:待补充
|
||||
- 幂等性或重试说明:待补充
|
||||
28
docs/architecture.md
Normal file
28
docs/architecture.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 架构设计
|
||||
|
||||
## 1. 系统上下文
|
||||
- 待补充
|
||||
|
||||
## 2. 模块边界
|
||||
- 待补充
|
||||
|
||||
## 3. 模块职责
|
||||
- 待补充
|
||||
|
||||
## 4. 请求流与数据流
|
||||
- 待补充
|
||||
|
||||
## 5. 集成点
|
||||
- 待补充
|
||||
|
||||
## 6. 技术约束
|
||||
- 待补充
|
||||
|
||||
## 7. 技术取舍
|
||||
- 待补充
|
||||
|
||||
## 8. 风险
|
||||
- 待补充
|
||||
|
||||
## 9. 推荐实施顺序
|
||||
- 待补充
|
||||
19
docs/db-design.md
Normal file
19
docs/db-design.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 数据设计
|
||||
|
||||
## 1. 实体或数据表
|
||||
- 待补充
|
||||
|
||||
## 2. 字段说明
|
||||
- 待补充
|
||||
|
||||
## 3. 关系
|
||||
- 待补充
|
||||
|
||||
## 4. 索引
|
||||
- 待补充
|
||||
|
||||
## 5. 迁移说明
|
||||
- 待补充
|
||||
|
||||
## 6. 数据完整性规则
|
||||
- 待补充
|
||||
28
docs/deployment.md
Normal file
28
docs/deployment.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 部署说明
|
||||
|
||||
## 1. 构建要求
|
||||
- 待补充
|
||||
|
||||
## 2. 运行要求
|
||||
- 待补充
|
||||
|
||||
## 3. 环境变量
|
||||
- 待补充
|
||||
|
||||
## 4. 本地启动步骤
|
||||
- 待补充
|
||||
|
||||
## 5. 预发与生产部署步骤
|
||||
- 待补充
|
||||
|
||||
## 6. CI/CD 流程
|
||||
- 待补充
|
||||
|
||||
## 7. 监控与日志
|
||||
- 待补充
|
||||
|
||||
## 8. 备份与回滚方案
|
||||
- 待补充
|
||||
|
||||
## 9. 运维风险
|
||||
- 待补充
|
||||
19
docs/design-system.md
Normal file
19
docs/design-system.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 设计系统说明
|
||||
|
||||
## 核心组件
|
||||
- 待补充
|
||||
|
||||
## 使用规则
|
||||
- 待补充
|
||||
|
||||
## 交互行为
|
||||
- 待补充
|
||||
|
||||
## 间距与布局约定
|
||||
- 待补充
|
||||
|
||||
## 排版与色彩说明
|
||||
- 待补充
|
||||
|
||||
## 无障碍说明
|
||||
- 待补充
|
||||
31
docs/prd.md
Normal file
31
docs/prd.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 产品需求文档
|
||||
|
||||
## 文档用途
|
||||
用于记录当前功能或项目的核心需求,作为后续架构、设计、实现、测试与部署的统一输入。
|
||||
|
||||
## 1. 问题陈述
|
||||
- 待补充
|
||||
|
||||
## 2. 目标用户
|
||||
- 待补充
|
||||
|
||||
## 3. 项目目标
|
||||
- 待补充
|
||||
|
||||
## 4. 非目标
|
||||
- 待补充
|
||||
|
||||
## 5. 范围说明
|
||||
- 待补充
|
||||
|
||||
## 6. 约束条件
|
||||
- 待补充
|
||||
|
||||
## 7. 假设前提
|
||||
- 待补充
|
||||
|
||||
## 8. 风险项
|
||||
- 待补充
|
||||
|
||||
## 9. 成功标准
|
||||
- 待补充
|
||||
5
docs/test-cases.md
Normal file
5
docs/test-cases.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 测试用例
|
||||
|
||||
| 测试用例 ID | 功能或故事映射 | 前置条件 | 操作步骤 | 预期结果 | 实际结果 / 状态 | 优先级 | 回归相关 |
|
||||
| --- | --- | --- | --- | --- | --- | --- | --- |
|
||||
| TC-001 | 待补充 | 待补充 | 待补充 | 待补充 | 未执行 | 待补充 | 待补充 |
|
||||
19
docs/ui-flow.md
Normal file
19
docs/ui-flow.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 交互流程
|
||||
|
||||
## 关键流程
|
||||
- 待补充
|
||||
|
||||
## 决策点与分支
|
||||
- 待补充
|
||||
|
||||
## 空状态
|
||||
- 待补充
|
||||
|
||||
## 加载状态
|
||||
- 待补充
|
||||
|
||||
## 错误状态
|
||||
- 待补充
|
||||
|
||||
## 权限或登录状态
|
||||
- 待补充
|
||||
13
docs/ui-ia.md
Normal file
13
docs/ui-ia.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 信息架构
|
||||
|
||||
## 页面或屏幕清单
|
||||
- 待补充
|
||||
|
||||
## 导航层级
|
||||
- 待补充
|
||||
|
||||
## 主要入口点
|
||||
- 待补充
|
||||
|
||||
## 核心任务路径
|
||||
- 待补充
|
||||
5
docs/user-stories.md
Normal file
5
docs/user-stories.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 用户故事
|
||||
|
||||
| 用户故事 ID | 用户角色 | 故事陈述 | 业务价值 | 优先级 | 依赖项 |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| US-001 | 待补充 | 作为……我希望……以便…… | 待补充 | 待补充 | 待补充 |
|
||||
Reference in New Issue
Block a user