Files
codex-agent-template/docs/README.md
shenjianZ 776874b4f9 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 临时文件
2026-03-21 16:39:21 +08:00

22 lines
780 B
Markdown

# 文档目录说明
本目录存放项目正式文档和多 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/`
- 如果仓库中已经有对应文档,应优先合并或更新,而不是重复创建。
- 当某些模板暂时不适用时,可以保留文件,但应在内容中标记“本项目暂不适用”。