PlantUML Awesome 架构绘图
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_c1d16043/plantuml-awesome 技能。
技能介绍
要解决的具体问题
智能体生成 PlantUML 时,常见三类问题:语法与渲染环境不匹配、关系缺少说明导致图难读、试图用一张图塞下过多信息。本技能强调以图族和抽象层级为先的生成方式,并给出校验清单,目标是让输出能被本地 plantuml 或文档系统稳定渲染,同时让阅读者快速理解边界、角色和消息。
技能如何工作
- 路由规则明确:UML、C4、企业架构或需要产出
.puml时使用本技能;轻量 Markdown 内嵌图优先交给 Mermaid;明确要求 ProcessOn 或托管编辑时再走对应技能。 - 核心工作流:从请求与源材料中提取 actor、component、type、state、message、deployment node,选择合适图族与抽象层级,生成包含
@startuml/@enduml的完整代码块,并用别名和 package/boundary 控制可读性。 - 图族覆盖清晰:运行时交互使用 sequence/participant/actor,静态类型模型使用 class/interface/relationships,逻辑架构使用 component/package/interface,运行时拓扑使用 node/cloud/database/artifact,生命周期用 state,流程控制用 start/if/while/fork/stop,用户目标用 actor/usecase,C4 模型使用
C4 include及 Person、System、Container、Component。 - 写作约束:别名只定义一次并保持一致;关系上补充 protocol 或 purpose;逻辑架构与部署拓扑拥挤时拆图;C4 的 context、container、component 层级不混用;不使用远程
!include,除非用户接受网络依赖渲染;不虚构未证实的组件、协议、多重性或调用。 - 校验优先:优先用本地 PlantUML 渲染验证;没有渲染器时做结构检查,包括起始/结束指令是否匹配、别名与引用元素是否定义、关系方向和多重性是否有意给出、目标环境是否具备 C4 includes、源码是否泄漏 secret 或机器路径。
适用边界与注意点
适合需要独立 .puml 资产、C4/企业架构图、复杂依赖关系表达的场景。不适合追求极简内联草图或需要交互式托管编辑的场景;这类需求应切换到 Mermaid 或 ProcessOn 技能。默认内联返回 PlantUML 源码,只有用户要求或项目已有文档树约定时才保存 .puml,推荐 docs/diagrams/ 且绝不静默覆盖。
使用场景
- 在编写后端服务文档时,需要把调用链路整理成 PlantUML 时序图,并确保 `@startuml` 与 `@enduml` 完整。
- 设计微服务系统时,要用 C4 模型画出上下文、容器和组件三层视图,且不混用层级。
- 整理数据库表关系与领域模型,需要生成 class 图并明确标注关联方向与多重性。
- 搭建部署环境说明,要把 node、cloud、database 的拓扑结构画成独立的部署图而非逻辑架构图。
适合人员
- 后端工程师:需要在提交代码或撰写设计文档时,生成可被 PlantUML 渲染器直接编译的 `.puml` 时序图。
- 架构师:负责复杂系统演进,需要用 C4 模型拆解上下文、容器和组件,并保持各层级不混用。
- 技术文档工程师:要把接口交互或部署拓扑写进 Markdown 文档,希望智能体输出结构校验过的 PlantUML 源码。
- 开源仓库维护者:希望智能体按 `docs/diagrams/` 约定保存图表文件,且绝不静默覆盖已有图表。