多受众应用发现与文档提示

# **代码分析与系统文档生成提示词**

你是一名代码分析和系统文档专家。你的任务是分析本项目/工作区中提供的源代码，并生成一份全面的 Markdown 文档，作为面向多方受众（高管、技术、业务和产品）的入门指南。

## **指令**

分析提供的源代码并提取以下信息，将其组织成结构良好的 Markdown 文档：

---

## **1. 高管视角：执行摘要**

### **应用目的**
- 该系统的主要目标是什么？
- 它旨在从宏观层面解决什么问题？

### **工作原理（高层级）**
- 以简洁易懂的方式向非技术受众描述整个系统流程。
- 系统执行的主要步骤或过程是什么？

### **高层级业务规则**
- 识别并描述代码中实现的主要业务规则。
- 系统遵循的基本业务策略、约束或逻辑是什么？

### **主要优势**
- 该系统为组织或其用户带来了哪些主要优势？

---

## **2. 技术视角：技术概览**

### **系统架构**
- 根据代码分析描述整体系统架构。
- 它是否遵循特定的模式（例如，单体、微服务等）？
- 识别出的主要组件或模块是什么？

### **使用的技术（技术栈）**
- 列出项目中使用的所有编程语言、框架、库、数据库和其他技术。

### **主要技术流程**
- 详细说明系统内部的主要数据和执行流程。
- 不同组件之间如何相互作用？

### **关键组件**
- 识别并描述最重要的系统组件，解释它们在架构中的作用和职责。

### **代码复杂性（观察）**
- 根据你的分析，提供关于代码复杂性的一般性观察（例如，结构良好、模块化、明显更复杂的区域）。

### **图表**
- 生成高层级图表以可视化系统架构和行为：
  - 组件图（侧重于主要模块及其交互）
  - 数据流图（显示信息如何在系统中流动）
  - 类图（如果适用，展示关键类及其关系）
  - 简化部署图（如果可检测，显示组件运行位置）
  - 简化基础设施/部署图（如果基础设施细节明显）
- **在 Markdown 文件中使用 Mermaid 语法创建上述图表。图表应保持高层级，不要过于详细。**

---

## **3. 产品视角：产品摘要**

### **系统功能（详细）**
- 详细描述系统的主要功能。
- 用户可以执行哪些任务或操作？

### **系统面向的用户（用户/客户）**
- 识别系统的主要目标受众。
- 谁是从中受益的最终用户或客户？

### **解决的问题（满足的需求）**
- 系统帮助用户或组织解决了哪些具体问题？
- 它满足了哪些需求？

### **用例/用户旅程（高层级）**
- 系统的主要用例是什么？
- 用户如何与系统交互以实现其目标？

### **核心功能**
- 清晰简洁地列出最重要的系统功能。

### **业务领域**
- 识别系统涵盖的主要业务领域（例如，销售、库存、财务）。

---

## **分析局限性**

- 在代码分析过程中遇到了哪些主要局限性？
- 简要描述是什么限制了你对代码的理解。
- 提供减少或消除这些局限性的建议。

---

## **文档指南**

### **文档格式**
- 文档必须采用 Markdown 格式，每个部分都有清晰的标题和副标题。
- 使用列表、表格和其他 Markdown 元素来提高可读性和理解性。

### **附加说明**
- 专注于提供相关的高层级信息，避免过多的实现细节，除非对理解至关重要。
- 使用清晰、简洁、易懂的语言，适合多方受众。
- 根据代码分析尽可能具体。
- 将完整的响应生成为一份**格式良好的 Markdown (`.md`) 文档**。
- 使用**清晰直接的语言**。
- 根据上述部分使用**标题和副标题**。

### **文档标题**
**应用程序“<application-name>”的执行和业务分析**

### **文档摘要**
本文档是 <system-name> 系统源代码分析的结果，涵盖以下领域：

- **高管视角：** 应用程序目的、高层级操作、主要业务规则和关键优势的摘要。
- **技术视角：** 系统架构、所用技术、主要流程、关键组件和图表（组件、数据流、类和部署）的详细信息。
- **产品视角：** 系统功能、目标用户、解决的问题、主要用例、功能和业务领域的详细描述。
- **分析局限性：** 识别关键分析约束并提出克服它们的建议。

分析基于可用的源代码文件。

---

## **重要提示**
分析必须考虑**所有项目文件**。
阅读并理解执行任务所需**所有必要文件**，以实现对系统的完整理解。

---

## **行动**
请分析我当前环境/工作区中可用的源代码，并生成所请求的 Markdown 文档。

输出文件名必须遵循以下格式：
`<yyyy-mm-dd-project-name-app-discovery_cursor.md>`