需求文档模板生成
前置要求：请先阅读 docs/01-项目扫描报告.md、docs/02-项目架构文档.md 和 docs/03-核心模块识别.md，基于前三步的分析结果生成适合当前项目的需求文档模板。
核心目标：为第四步的模块需求文档生成提供标准化、项目适配的文档模板。
第一步：项目特征分析和模板策略
1. 项目特征确认
请基于前三步分析结果确认项目特征：
- 项目类型：[基于架构文档确认：桌面应用/前端应用/移动应用/后端服务/库项目等]
- 技术栈特点：[基于扫描报告确认：主要语言、框架、工具链]
- 架构模式：[基于架构文档确认：分层架构、组件化、微服务等]
- 模块特点：[基于模块识别确认：模块类型、数量、复杂度]
- 业务特征：[基于前三步分析确认：业务复杂度、领域特点]
2. 模板设计策略
请根据项目特征选择合适的模板设计策略：
2.1 内容结构策略
- 桌面应用：重点关注界面交互、系统集成、性能要求
- 前端应用：重点关注组件设计、状态管理、用户体验
- 移动应用：重点关注界面适配、生命周期、平台特性
- 后端服务：重点关注接口设计、数据处理、性能扩展
- 库/框架：重点关注API设计、兼容性、使用示例
2.2 技术规范策略
- 基于实际技术栈：使用项目实际采用的技术术语和规范
- 基于架构模式：适配项目的实际架构设计模式
- 基于开发工具：结合项目的构建工具和开发流程
第二步：模板结构设计
3. 模板基础结构
请设计适合当前项目的需求文档基础结构：
3.1 文档头部信息
1
2
3
4
5
6
7
8
9
# [模块名称] 需求文档
## 文档信息
- **模块名称**：[模块标识名称]
- **文档版本**：[版本号]
- **创建日期**：[日期]
- **最后更新**：[日期]
- **文档状态**：[草稿/审核中/已确认]
- **相关文档**：[关联的其他文档]
3.2 模块基本信息（项目适配）
请根据项目类型设计模块基本信息字段：
- 通用字段：模块标识、文件路径、模块类型、重要程度
- 项目特定字段：[根据项目类型添加特有字段]
4. 功能需求模板设计
请根据项目特点设计功能需求描述模板：
4.1 功能概述模板
1
2
3
4
5
## 功能概述
- **核心功能**：[模块的主要功能描述]
- **功能边界**：[模块功能的边界和范围]
- **使用场景**：[模块的典型使用场景]
- **用户群体**：[模块的目标用户或调用方]
4.2 详细功能需求模板
请根据项目类型设计详细功能需求格式：
- 功能点列表：[具体功能点的描述格式]
- 输入输出：[输入输出的描述格式]
- 处理逻辑：[处理逻辑的描述格式]
- 异常处理：[异常情况的处理格式]
第三步：技术规范模板设计
5. 接口定义模板
请根据项目技术栈设计接口定义模板：
5.1 接口描述格式（项目适配）
根据项目类型选择合适的接口描述格式：
- 函数/方法接口：适用于库、工具类模块
- API接口：适用于后端服务模块
- 组件接口：适用于前端组件模块
- 类接口：适用于面向对象的模块
- 配置接口：适用于配置管理模块
5.2 接口规范模板
1
2
3
4
5
6
7
8
## 接口定义
### [接口名称]
- **接口类型**：[根据项目确定类型]
- **接口描述**：[接口功能描述]
- **输入参数**：[参数列表和说明]
- **返回值**：[返回值格式和说明]
- **使用示例**：[代码示例]
- **注意事项**：[使用注意事项]
6. 数据结构模板
请根据项目数据处理特点设计数据结构模板：
6.1 数据模型模板
1
2
3
4
5
6
7
## 数据结构
### [数据结构名称]
- **数据类型**：[根据项目技术栈确定]
- **字段定义**：[字段列表和说明]
- **数据约束**：[数据验证和约束规则]
- **存储方式**：[数据存储和持久化方式]
- **数据流向**：[数据的输入输出流向]
7. 技术要求模板
请根据项目技术特点设计技术要求模板：
7.1 技术规范模板
1
2
3
4
5
6
## 技术要求
- **技术栈要求**：[基于项目实际技术栈]
- **性能要求**：[性能指标和要求]
- **兼容性要求**：[兼容性和适配要求]
- **安全要求**：[安全相关要求]
- **质量要求**：[代码质量和测试要求]
第四步：质量保证和验证
8. 模板完整性验证
请验证生成的模板是否完整和适用：
8.1 内容完整性检查
- 基础信息：是否包含了模块的基本信息字段？
- 功能需求：是否覆盖了功能需求的各个方面？
- 技术规范：是否包含了技术实现的关键要素？
- 质量标准：是否定义了质量和验收标准？
8.2 项目适配性检查
- 技术栈匹配：模板是否适配项目的技术栈？
- 架构模式匹配：模板是否符合项目的架构模式？
- 业务特征匹配：模板是否适合项目的业务特征？
- 模块特点匹配：模板是否适合项目的模块特点？
9. 模板使用说明
请为模板提供使用说明：
9.1 填写指导
1
2
3
4
5
6
## 模板使用说明
### 填写指导
- **必填字段**：[标注哪些字段是必须填写的]
- **可选字段**：[标注哪些字段是可选的]
- **填写格式**：[说明各字段的填写格式要求]
- **示例参考**：[提供填写示例]
9.2 质量检查清单
1
2
3
4
5
6
7
### 质量检查清单
完成需求文档后，请确认：
- [ ] 所有必填字段都已填写
- [ ] 功能描述清晰准确
- [ ] 接口定义完整可用
- [ ] 技术要求明确具体
- [ ] 示例代码正确有效
输出要求
- 格式：使用Markdown格式
- 保存路径：docs/需求文档模板.md
- 模板结构：完整的需求文档模板结构
- 使用说明：详细的模板使用指导
- 项目适配：基于项目特征的定制化设计
- 质量保证：包含验证和检查机制
最终验证清单
完成模板生成后，请确认：
- 基于前三步分析结果设计了模板
- 模板适配了当前项目的特征
- 包含了完整的需求文档结构
- 提供了详细的使用说明
- 设计了质量检查机制
- 为第四步提供了标准化模板