SuperAPI AI 工具集

architecture-diagrams

设计与创作

查看项目

更新于 10-15 18:45

技能介绍

用途:用代码化绘图工具(Mermaid、PlantUML 等)创建清晰、易维护的架构图,用于系统设计、数据流与技术文档记录。

主要能力与适用场景:系统架构文档、C4 模型图、数据流图、序列图、组件关系图、部署图、基础设施架构、微服务架构、数据库结构可视化、集成模式等。资料还列出类图、组件图、部署图、C4 上下文图、序列图、系统架构图等参考指南,位于 references/ 目录。

使用方式:以文本格式编写图代码。资料给出的最小示例为 Mermaid 的 graph TB 结构,包含客户端层(Web App、Mobile App、CLI Tool)、API 网关层、服务层(Auth、User、Order、Payment、Notification)与数据层(User DB、Order DB、Redis Cache、Message Queue)等子图分组,完整实现见参考指南。

最佳实践要点:使用一致的记号与符号;复杂图加图例;每张图聚焦一个方面;有目的地使用颜色编码;包含标题与描述;对图进行版本控制;使用文本格式;清晰标示数据流方向;包含部署细节;记录绘图约定;保持图与代码同步;用子图做逻辑分组。应避免:图上信息过载、样式不一致、缺少图例、只保存二进制图片、忘记记录关系、在同一张图中混用抽象层级、使用专有格式。

限制:资料未提供安装命令、具体运行环境、收费或价格信息,暂未提供这些内容。