多受众应用发现与文档生成提示
分析工作区内全部源代码,生成面向高管、技术、业务与产品受众的 Markdown 入职文档,涵盖执行摘要、系统架构、技术栈、关键组件与业务规则,并用 Mermaid 绘制高层级图表、说明分析局限。
完整提示词
# **用于代码分析和系统文档生成的提示词** 你是一名代码分析与系统文档领域的专家。你的任务是分析本项目/工作区中提供的源代码,并生成一份全面的 Markdown 文档,作为面向多个受众(高管、技术、业务和产品)的入职指南。 ## **指令** 分析所提供的源代码,提取以下信息,并将其组织成结构清晰的 Markdown 文档: --- ## **1. 高管级视图:执行摘要** ### **应用目的** - 该系统的主要目标是什么? - 它旨在解决哪些高层级问题? ### **工作方式(高层级)** - 以简洁且易于理解的方式描述整体系统流程,供非技术人员阅读。 - 系统执行的主要步骤或流程有哪些? ### **高层级业务规则** - 识别并描述代码中实现的主要业务规则。 - 系统遵循的基本业务政策、约束或逻辑是什么? ### **关键优势** - 该系统为组织或其用户带来的主要好处是什么? --- ## **2. 技术级视图:技术概览** ### **系统架构** - 基于代码分析描述整体系统架构。 - 是否遵循特定模式(例如,单体架构 Monolithic、微服务 Microservices 等)? - 识别出的主要组件或模块有哪些? ### **使用的技术(技术栈)** - 列出项目中使用的所有编程语言、框架、库、数据库及其他技术。 ### **主要技术流程** - 详细说明系统内的主要数据流和执行流程。 - 不同组件之间如何交互? ### **关键组件** - 识别并描述最重要的系统组件,解释其在架构中的角色与职责。 ### **代码复杂度(观察结果)** - 根据你的分析,提供关于代码复杂度的一般性观察(例如,结构良好、模块化程度高、某些区域明显复杂等)。 ### **图表** - 生成高层级图表以可视化系统架构与行为: - 组件图(聚焦主要模块及其交互) - 数据流图(展示信息如何在系统中流动) - 类图(呈现关键类及其关系,如适用) - 简化部署图(显示组件运行位置,若可检测到) - 简化基础设施/部署图(若基础设施细节明显) - **使用 Mermaid 语法在 Markdown 文件中创建上述图表。图表应保持高层级,不得过于详细。** --- - **技术层面视图:** 关于系统架构、使用的技术、主要流程、关键组件以及图表(组件图、数据流图、类图和部署图)的详细信息。 - **产品视图:** 关于系统功能、目标用户、解决的问题、主要用例、功能特性以及业务领域的详细描述。 - **分析局限性:** 识别关键的分析限制,并提出克服这些限制的建议。 本次分析基于可用的源代码文件。 --- ## **重要** 分析必须考虑 **项目中的所有文件**。 阅读并理解执行任务所需的 **所有必要文件**,以实现对系统的完整理解。 --- ## **操作** 请分析我当前环境/工作区中可用的源代码,并生成所请求的 Markdown 文档。 输出文件名必须遵循以下格式: `<yyyy-mm-dd-project-name-app-discovery_cursor.md>`
分类与标签
编程开发、编程开发、代码、分析