首页 AI系列82:项目架构文档生成提示词2
文章
取消

AI系列82:项目架构文档生成提示词2

项目架构文档生成

前置要求:请先阅读 docs/01-项目扫描报告.md,基于扫描结果进行深度架构分析。

请根据项目扫描结果,深度分析整个项目代码库,生成完整的架构文档。

第一轮:基础架构分析

1. 项目概览(基于扫描结果验证和补充)

  • 项目标识:[项目名称、版本、仓库信息]
  • 核心功能:[详细功能描述,基于代码实现验证扫描结果]
  • 项目规模确认:[验证扫描报告中的规模评估,提供准确数据]
  • 应用领域:[从代码逻辑推断应用领域和使用场景]
  • 目标用户:[基于功能特性推断目标用户群体]

2. 技术架构深度分析

请基于实际代码结构进行具体分析:

2.1 架构模式识别

通过分析代码结构,识别项目采用的架构模式:

  • 目录结构分析:分析项目的目录组织方式和命名规范
  • 入口点识别:找到项目的主要入口文件和启动逻辑
  • 模块划分:从代码组织方式推断模块划分策略
  • 架构风格确定:基于实际实现识别采用的架构模式

2.2 核心组件分析

深入分析项目的核心技术组件:

  • 主要模块:识别项目中的主要功能模块和组件
  • 数据处理:分析数据的获取、处理、存储方式
  • 业务逻辑:识别核心业务逻辑的实现和封装方式
  • 通用组件:分析工具类、帮助函数、通用模块等
  • 第三方集成:识别集成的外部库和服务

2.3 系统交互分析

分析项目内部和外部的交互方式:

  • 内部通信:模块间的调用关系和数据传递方式
  • 外部接口:与外部系统、服务、API的交互方式
  • 数据流向:数据在系统中的流转路径和处理过程
  • 事件处理:事件的产生、传播、处理机制
  • 状态管理:系统状态的维护和更新方式

2.4 技术实现分析

基于代码分析项目的技术实现:

  • 核心算法:识别项目中的关键算法和实现逻辑
  • 数据结构:分析使用的主要数据结构和存储方式
  • 性能优化:识别性能优化的实现和策略
  • 错误处理:异常处理、错误恢复的实现机制
  • 配置管理:配置文件、参数管理的实现方式

2.5 质量保证分析

分析项目的质量保证实现:

  • 代码规范:代码风格、命名规范、注释质量
  • 测试覆盖:单元测试、集成测试的实现情况
  • 日志记录:日志系统的实现和使用情况
  • 监控机制:性能监控、状态检查的实现
  • 文档完整性:代码文档、API文档的完整程度

分析要求:

  1. 基于实际代码:所有分析必须基于真实的代码实现,不能臆测
  2. 提供代码证据:每个架构组件都要指出对应的文件路径和关键代码
  3. 分析依赖关系:梳理组件间的实际调用和依赖关系
  4. 识别设计模式:从代码中识别使用的设计模式和最佳实践
  5. 评估架构质量:分析架构的合理性、可扩展性、可维护性

3. 系统架构图绘制

请根据项目实际架构特点绘制架构图,AI自动识别项目类型并选择合适的架构层次:

# 请基于实际项目结构绘制,可能包含但不限于:
# 桌面应用:UI层 -> 业务逻辑层 -> 数据访问层 -> 系统API层
# 前端应用:视图层 -> 状态管理层 -> 服务层 -> API层
# 移动应用:界面层 -> 控制层 -> 模型层 -> 网络层
# 后端服务:接口层 -> 业务层 -> 数据层 -> 基础设施层
# 根据实际代码结构确定具体的架构分层

4. 技术栈详细清单(验证扫描结果)

请根据项目实际使用的技术进行分类分析:

  • 核心技术栈:[主要语言、框架版本,验证扫描报告准确性]
  • 依赖管理:[包管理器、依赖版本策略、第三方库管理]
  • 数据处理:[数据存储方式、数据格式、持久化方案]
  • 外部集成:[第三方服务、API集成、外部库使用]
  • 开发工具链:[构建工具、测试框架、代码质量工具]
  • 运行环境:[目标平台、运行时环境、部署方式]

5. 数据处理架构分析

请根据项目实际的数据处理方式进行分析:

  • 数据模型:[项目中使用的数据结构和模型定义]
  • 数据流转:[数据在系统中的获取、处理、传递过程]
  • 存储方案:[数据持久化方式,如文件、数据库、缓存等]
  • 数据安全:[数据保护、访问控制、敏感信息处理]
  • 数据流程图:[用Mermaid绘制关键数据处理流程]

6. 配置和运行环境

请根据项目实际的配置和运行方式进行分析:

  • 配置管理:[配置文件、参数设置、环境变量使用]
  • 环境要求:[运行环境、依赖条件、系统要求]
  • 启动流程:[应用启动过程、初始化步骤、依赖检查]
  • 运行架构:[运行时结构、资源管理、性能优化]

第二轮:架构验证和补充

7. 架构合理性验证

请对生成的架构文档进行自我验证:

  • 代码实现一致性:架构描述是否与实际代码实现一致?
  • 技术选型合理性:技术栈选择是否符合业务需求?
  • 架构完整性:是否遗漏了重要的架构组件?
  • 性能考虑:架构设计是否考虑了性能和扩展性?

8. 问题识别和改进建议

  • 架构问题:[识别的架构缺陷和技术债务]
  • 性能瓶颈:[潜在的性能问题点]
  • 安全风险:[安全漏洞和风险点]
  • 改进建议:[架构优化和重构建议]

9. 关键功能流程分析

请根据项目类型识别和分析核心功能流程:

  • 核心功能流程:[识别3-5个最重要的功能执行流程]
  • 流程图绘制:[用Mermaid绘制关键功能流程]
  • 异常处理:[错误处理和异常恢复机制]
  • 性能关键路径:[影响性能的关键执行路径分析]

第三轮:质量保证和最终检查

10. 多维度质量检查

技术准确性检查:

  1. 所有文件路径是否真实存在?
  2. 技术栈版本信息是否准确?
  3. 配置示例是否可用?
  4. 架构图是否能正确渲染?

内容完整性检查:

  1. 是否覆盖了扫描报告中的所有重点?
  2. 是否遗漏了重要的架构组件?
  3. 业务流程描述是否完整?
  4. 技术选型说明是否充分?

逻辑一致性检查:

  1. 架构描述与代码实现是否一致?
  2. 不同章节的信息是否相互矛盾?
  3. 技术栈之间的集成关系是否合理?
  4. 数据流向是否逻辑清晰?

11. 错误修正和优化

如发现问题,请:

  1. 标注问题类型:[技术错误/信息缺失/逻辑矛盾]
  2. 说明修正原因:[为什么需要修正]
  3. 提供修正方案:[具体的修正内容]
  4. 验证修正结果:[确认修正后的准确性]

输出要求

  • 格式:使用Markdown格式
  • 保存路径:docs/02-项目架构文档.md
  • 图表要求:所有架构图使用Mermaid语法
  • 代码示例:包含关键配置和代码片段
  • 不确定标注:不确定信息标注”[需要确认]”
  • 引用标注:引用扫描报告的信息标注”[来源:扫描报告]”

最终验证清单

完成文档后,请确认:

  • 与项目扫描报告信息一致
  • 所有架构图能正确渲染
  • 技术栈信息准确无误
  • 业务流程描述完整
  • 配置示例真实可用
  • 问题和建议具有可操作性
  • 文档结构清晰易读
  • 为后续模块分析提供了充分信息
本文由作者按照 CC BY 4.0 进行授权

AI系列81:根据代码反推文档提示词1

AI系列83:第三步核心模块智能识别提示词