# 需求文档目录 本目录用于存放项目各阶段的需求文档。 ## 目录结构 ``` requirements/ ├── business/ # 业务需求 │ ├── brd-001.md # 业务需求文档 │ └── market-*.md # 市场调研文档 ├── functional/ # 功能需求 │ ├── epic-*.md # 史诗级需求 │ ├── feature-*.md # 功能需求 │ └── story-*.md # 用户故事 └── non_functional/ # 非功能需求 ├── performance.md # 性能需求 ├── security.md # 安全需求 └── reliability.md # 可靠性需求 ``` ## 文档命名规范 | 类型 | 命名格式 | 示例 | |-----|---------|------| | 业务需求 | `brd-XXX.md` | `brd-001-平台概述.md` | | 功能史诗 | `epic-XXX.md` | `epic-001-交易模块.md` | | 功能需求 | `feature-XXX-模块-功能.md` | `feature-001-gateway-ctp.md` | | 用户故事 | `story-XXX.md` | `story-001-订单撤单.md` | | 接口需求 | `api-XXX.md` | `api-001-行情接口.md` | ## 文档模板 ### 业务需求文档 (BRD) 模板 创建 `business/brd-template.md`: ```markdown # [项目名称] 业务需求文档 ## 1. 项目背景 ## 2. 业务目标 ## 3. 目标用户 ## 4. 业务范围 ## 5. 竞争分析 ## 6. 成功指标 ``` ### 功能需求文档模板 创建 `functional/feature-template.md`: ```markdown # [功能名称] 需求文档 ## 需求概述 ## 用户角色 ## 功能描述 ## 验收标准 - [ ] 标准1 - [ ] 标准2 ## 优先级 P0 / P1 / P2 / P3 ## 依赖关系 ## 相关链接 - Issue: #xxx - 设计文档: ../design/xxx.md ``` ## 工作流程 ```mermaid graph LR A[业务需求] --> B[功能分解] B --> C[技术评审] C --> D[排期开发] D --> E[验收测试] ```