企业级模块需求文档生成
前置要求：请先阅读以下文档，基于完整的项目分析结果进行专业级需求文档生成：
docs/01-项目扫描报告.mddocs/02-项目架构文档.mddocs/03-核心模块识别.mddocs/需求文档模板.md
核心目标：为指定模块生成企业级、专业性的详细需求文档，确保文档质量达到商业项目标准。
第一轮：模块深度分析
1. 目标模块确认
请从模块识别结果中选择要分析的模块：
1
2
3
4
5
6
7
### [序号]. [模块名称]
- **模块标识**：[准确的模块名称]
- **主要目录/文件**：[2-3个关键路径]
- **模块类型**：[核心功能/基础支撑/工具辅助/配置管理]
- **主要职责**：[1-2句话概括核心功能]
- **重要程度**：[高/中/低]
2. 项目上下文分析
请基于前三步分析结果，确认项目上下文：
- 项目类型：[基于架构文档确认项目类型]
- 技术栈：[基于扫描报告确认相关技术栈]
- 架构位置：[模块在整体架构中的位置和作用]
- 业务价值：[模块对整个项目的业务价值]
3. 模块代码深度分析
请对目标模块进行全面的代码分析：
3.1 代码结构分析
- 文件组织：分析模块内部的文件组织结构
- 代码规模：统计代码行数、函数数量、类数量等
- 复杂度评估：评估代码的复杂度和维护难度
- 代码质量：分析代码规范、注释覆盖率、测试覆盖率
3.2 功能实现分析
- 核心功能识别：识别模块实现的所有核心功能
- 功能边界确定：明确模块功能的边界和范围
- 业务逻辑提取：从代码中提取完整的业务逻辑
- 算法和数据结构：分析使用的关键算法和数据结构
3.3 接口和依赖分析
- 对外接口：分析模块对外暴露的所有接口
- 内部接口：分析模块内部的接口设计
- 依赖关系：分析模块的输入输出依赖
- 数据流向：分析数据在模块中的流转过程
第二轮：需求文档生成
4. 基于模板的文档生成
请严格按照 docs/需求文档模板.md 的结构生成需求文档：
4.1 文档头部信息
- 使用模板中定义的文档头部格式
- 填入准确的模块信息和文档元数据
- 确保文档版本和状态信息完整
4.2 模块基本信息
- 按照模板中的项目适配字段填写
- 包含模块的完整标识和分类信息
- 提供准确的文件路径和组织结构
4.3 功能需求详述
请根据项目类型和模板要求，详细描述功能需求：
功能概述
- 核心价值：模块为项目提供的核心价值
- 功能边界：明确的功能边界和职责范围
- 使用场景：详细的使用场景和用户故事
- 业务流程：完整的业务处理流程
详细功能需求
- 功能点清单：完整的功能点列表和优先级
- 输入输出规范：详细的输入输出数据规范
- 处理逻辑：核心处理逻辑的详细描述
- 异常处理：完整的异常情况处理机制
- 边界条件：各种边界条件的处理方式
4.4 技术规范定义
请根据项目技术栈和模板要求，定义技术规范：
接口定义（项目适配）
- 接口类型：根据项目类型确定接口类型
- 接口规范：详细的接口参数和返回值定义
- 调用方式：接口的调用方式和协议
- 错误码定义：完整的错误码和异常处理
- 使用示例：实际的代码使用示例
数据结构定义
- 数据模型：完整的数据模型定义
- 数据约束：数据验证规则和约束条件
- 存储方案：数据的存储和持久化方案
- 数据流向：数据的输入输出和流转路径
技术要求
- 性能要求：具体的性能指标和要求
- 兼容性要求：平台和版本兼容性要求
- 安全要求：安全相关的技术要求
- 质量要求：代码质量和测试覆盖率要求
第三轮：文档质量保证
5. 企业级质量标准验证
请按照企业级文档标准进行质量验证：
5.1 内容完整性验证
- 需求覆盖度：是否覆盖了模块的所有功能需求？
- 技术规范完整性：技术规范是否完整和准确？
- 接口定义完整性：接口定义是否完整可实现？
- 示例代码完整性：示例代码是否完整可运行？
5.2 专业性和准确性验证
- 术语使用准确性：专业术语使用是否准确？
- 技术描述准确性：技术描述是否与实际代码一致？
- 业务逻辑准确性：业务逻辑描述是否准确完整？
- 数据结构准确性：数据结构定义是否准确？
5.3 可实现性验证
- 技术可行性：技术方案是否可行？
- 接口可调用性：接口定义是否可以实际调用？
- 数据结构可用性：数据结构是否可以实际使用？
- 性能要求合理性：性能要求是否合理可达？
6. 文档优化和完善
请对生成的文档进行优化和完善：
6.1 结构优化
- 逻辑结构：优化文档的逻辑结构和层次
- 内容组织：优化内容的组织和表达方式
- 格式规范：确保格式符合企业文档标准
- 可读性：提升文档的可读性和理解性
6.2 内容补充
- 遗漏补充：补充遗漏的重要信息
- 细节完善：完善技术细节和实现要点
- 示例丰富：增加更多的使用示例和场景
- 注意事项：添加重要的注意事项和限制条件
输出要求
- 格式标准：严格按照企业级Markdown文档格式
- 保存路径：docs/模块需求文档/[模块名称]-需求文档.md
- 文档结构：完全按照需求文档模板的结构
- 质量标准：达到企业级商业项目的文档质量标准
- 专业性：使用专业的技术术语和规范表达
- 完整性：确保文档内容完整、准确、可实现
- 不确定标注：不确定信息标注”[需要确认]”
- 来源标注：引用前面分析结果标注”[来源：XX文档]”
最终验证清单
完成需求文档后，请确认：
- 基于完整的项目分析结果生成文档
- 严格按照需求文档模板结构
- 达到企业级文档质量标准
- 所有技术规范准确可实现
- 所有接口定义完整可调用
- 所有示例代码正确可运行
- 文档结构清晰逻辑合理
- 专业术语使用准确规范
- 内容完整覆盖所有功能点
- 可以直接用于开发实现