代码分析与系统文档生成器
来自 Wikiprompt,自由的提示词百科全书
代码分析与系统文档生成器 一个全面的系统提示,指示AI分析源代码并生成面向多受众的Markdown文档,涵盖高管、技术和产品视角,包括Mermaid图表。
提示词内容收藏
🌐
# 执行与业务分析文档 - "未命名应用"
## 文档摘要
本文档是对当前工作区中源代码分析的结果,涵盖以下领域:
- **执行级视图**:应用目的、高层运作方式、主要业务规则及关键收益的摘要。
- **技术级视图**:系统架构、所用技术、主要流程、关键组件及图表(组件、数据流、类及部署)的详细信息。
- **产品视图**:系统功能详情、目标用户、解决的问题、主要用例、功能特性及业务领域。
- **分析局限性**:识别关键分析约束及克服建议。
本次分析基于当前环境中可用的源代码文件。
---
## 1. 执行级视图:执行摘要
### 应用目的
当前工作区中**未检测到源代码文件**。因此,无法确定该系统的核心目标或它旨在解决的高层问题。
### 运作方式(高层)
由于没有可分析的源代码,无法描述系统的高层运作流程或主要步骤。
### 高层业务规则
由于没有可分析的源代码,无法识别或描述系统所实现的业务规则、政策或约束。
### 关键收益
由于没有可分析的源代码,无法确定该系统为组织或用户带来的主要收益。
---
## 2. 技术级视图:技术概览
### 系统架构
由于工作区中不存在源代码文件,无法确定系统架构模式(如单体架构、微服务架构等)或识别主要组件与模块。
### 所用技术(技术栈)
由于没有可分析的源代码,无法列出项目中所用的编程语言、框架、库、数据库或其他技术。
### 主要技术流程
由于没有可分析的源代码,无法描述系统内的数据流、执行流或组件间的交互方式。
### 关键组件
由于没有可分析的源代码,无法识别或描述系统中的关键组件及其职责。
### 代码复杂度(观察)
由于没有可分析的源代码,无法对代码结构、模块化程度或复杂度提供任何观察。
### 图表
由于没有可分析的源代码,无法生成组件图、数据流图、类图或部署图。
---
## 3. 产品视图:产品摘要
### 系统功能(详细)
由于没有可分析的源代码,无法描述系统的具体功能或用户可执行的操作。
### 目标用户 / 客户
由于没有可分析的源代码,无法确定系统的目标受众或受益用户。
### 解决的问题(满足的需求)
由于没有可分析的源代码,无法确定系统为用户或组织解决的具体问题或满足的需求。
### 用例 / 用户旅程(高层)
由于没有可分析的源代码,无法描述主要用例或用户与系统的交互方式。
### 核心功能
由于没有可分析的源代码,无法列出系统的核心功能。
### 业务领域
由于没有可分析的源代码,无法识别系统所覆盖的业务领域(如销售、库存、财务等)。
---
## 分析局限性
### 主要局限
- **源代码缺失**:当前工作区中未检测到任何源代码文件。这从根本上限制了对系统任何方面的分析能力。
- **无项目结构**:没有项目目录结构、配置文件或文档可供参考。
- **无构建或部署信息**:没有构建脚本、Docker 文件、CI/CD 配置或部署清单可供分析。
### 建议
为消除这些局限性并实现全面分析,建议采取以下措施:
1. **提供源代码**:将完整的源代码文件放入工作区,包括所有编程语言文件、配置文件、资源文件及文档。
2. **包含项目元数据**:提供项目结构说明、README 文件、架构决策记录(ADR)及任何现有设计文档。
3. **提供构建与部署配置**:包含构建脚本、依赖清单(如 package.json、requirements.txt、pom.xml 等)、Docker 配置及部署清单。
4. **提供数据库模式**:如适用,包含数据库模式、迁移脚本或数据模型文档。
5. **提供 API 文档**:如系统暴露 API,请提供 OpenAPI/Swagger 规范或等效文档。
---
*本文档基于当前工作区中可用的源代码生成。由于未检测到源代码文件,上述所有章节均反映分析受限的状态。*
用法
此提示词专为 coding 设计。复制上方内容并粘贴到你常用的 AI 工具中。
为获得最佳效果,可将占位符(方括号或大写字母标示)替换为你的具体需求。
讨论
0 条评论