# 系统架构图生成提示词模板
概述
这是一个通用的提示词模板,用于指导 AI 生成系统架构流程图。该模板基于对 OpenAPI 工具生成器架构图的分析,可适用于各种系统架构图的绘制需求。
提示词模板
请根据以下系统描述生成一个 Mermaid 系统架构流程图。架构图需要清晰展示系统的各个组件、模块之间的关系以及数据流向。
### 生成要求:
1. **使用子图组织结构**:
- 将系统按功能或逻辑模块划分为多个子图 (subgraph)
- 每个子图代表一个功能模块或组件集合
- 子图标题应简洁明了,反映模块的核心功能
- 常见子图类型包括:输入处理、业务逻辑、数据处理、存储管理、运行时调用、管理配置等
2. **节点定义**:
- 使用方括号 [ ] 表示数据源、输入或输出节点
- 使用普通名称表示处理函数、类或组件
- 节点名称应简洁且具有描述性
- 使用大写字母加数字作为节点标识符(如 A, B, C)
- 节点命名应体现其功能或作用
3. **关系表示**:
- 使用 --> 表示单向数据流向或处理顺序
- 使用 <--> 表示双向交互或依赖关系
- 确保关系方向符合实际的数据流或控制流
- 可使用不同类型的箭头来表示不同类型的关系
4. **架构层次**:
- 从输入源开始,展示数据处理的完整流程
- 体现系统的分层架构(如输入处理层、业务逻辑层、数据存储层等)
- 展示组件间的交互和依赖关系
- 明确展示数据流向和控制流向
5. **组件关系**:
- 明确展示全局组件与局部组件的交互
- 体现单例或全局实例(如 global_ 开头的组件)
- 展示工具注册、管理和调用的生命周期
- 体现配置管理与运行时的交互
6. **交互逻辑**:
- 明确展示运行时调用关系
- 体现管理后台或配置界面的维护功能
- 显示跨模块的交互和依赖
- 展示请求处理和响应返回的完整链路
7. **系统视图**:
- 体现静态配置与动态运行时的区分
- 展示工具注册流程与工具使用流程
- 体现管理功能与业务功能的分离
- 包含错误处理或异常流程(如适用)
### 具体系统描述:
{SYSTEM_DESCRIPTION}
### 期望输出格式:
```mermaid
graph TB
{SUBGRAPHS_AND_NODES}请确保:
- 使用 TB (Top to Bottom) 布局
- 子图之间有清晰的边界和功能区分
- 数据流向逻辑清晰,易于理解
- 包含所有关键组件和它们之间的关系
- 体现系统的整体架构和设计思路
- 遵循 Mermaid 语法规范
- 图表布局合理,避免交叉连线过多
## 使用说明
1. **替换占位符**:将 `{SYSTEM_DESCRIPTION}` 替换为具体的系统描述
2. **调整架构**:根据实际系统特点调整子图划分和节点关系
3. **优化布局**:确保图表布局清晰,避免节点重叠
4. **验证逻辑**:确认数据流向和组件关系符合实际系统设计
5. **细化节点**:根据需要添加更多细节或简化复杂部分
## 模板优势
1. **通用性强**:适用于各种类型的系统架构图
2. **结构清晰**:通过子图组织使复杂系统易于理解
3. **标准规范**:遵循 Mermaid 语法和架构图最佳实践
4. **可扩展性**:可根据具体需求调整模板细节
5. **易于维护**:结构化的模板便于后续修改和优化
6. **全面覆盖**:涵盖系统架构的各个关键方面
## 示例应用
该模板可以用于生成:
- 微服务架构图
- 数据处理流水线
- API 网关架构
- 认证授权系统
- 消息队列系统
- 数据库架构
- 工具注册管理
- 配置管理系统
- 以及其他任何复杂的系统架构图
## 架构模式参考
基于分析的 OpenAPI 工具生成器架构,以下是一些常见的子图组织模式:
1. **输入处理子图**:负责接收和解析输入数据
2. **处理逻辑子图**:核心业务逻辑处理
3. **数据管理子图**:数据存储和检索
4. **注册管理子图**:组件注册和管理
5. **运行时调用子图**:实际执行和调用
6. **管理配置子图**:系统配置和管理界面
这些模式可根据具体系统需求进行组合和调整。