Plantuml

📐 自然语言生成标准 UML 图表,本地渲染隐私可控

将自然语言描述转换为标准 PlantUML 图表代码,支持本地 Docker/Java 渲染生成 SVG/PNG/PDF,严格遵循 uml-diagrams.org 权威样式规范

收藏
4.7k
安装
1.1k
版本
1.5.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心功能

PlantUML Skill 是一套完整的 UML 图表生成工作流,覆盖需求解析 → PlantUML 代码生成 → 本地渲染输出三大环节。支持序列图、类图、活动图、用例图、组件图、部署图、状态图、甘特图、思维导图等 9 种标准图表类型,输出格式涵盖 SVG(默认)、PNG、PDF 及 TXT 纯文本。

显著优点

权威样式合规:强制采用 uml-diagrams.org 参考样式,严格匹配 OMG UML 2.x 规范——纯黑白配色、细线描边、无装饰阴影、文本化版型标识(如 «interface»),确保输出与学术及企业标准文档风格一致。

本地优先架构:默认使用 Docker(plantuml/plantuml)或本地 Java 运行 plantuml.jar 渲染,图表源码绝不离开用户主机;Kroki 公共服务器为显式 OPT-IN 选项,避免隐私泄露风险。

智能布局校正:内置高宽比(0.7–1.4)与 A4 纸面适配双重验证,自动注入方向调整(left to right/top to bottom)与缩放指令,兼顾打印可读性与视觉平衡。

多语言与暗色适配:--cjk 自动切换中文字体(文泉驿微米黑),--dark-mode 生成反色配套文件,满足国际化与深色主题需求。

潜在局限

1. 运行时依赖:需预装 Docker 或 Java 之一,纯容器隔离环境可能出现字体挂载权限问题
2. 复杂图表瓶颈:超大规模类图/序列图可能突破 A4 单页限制,需手动拆分或接受字号压缩警告

3. CJK 字体预置:Docker 方案依赖宿主机字体目录挂载,若主机未安装中文字体则渲染失败

4. 公共服务器风险:显式开启 --use-public-server 后,源码将 POST 至第三方(kroki.io 或自定义实例),不适用于含敏感架构或凭证的场景

适合人群

  • 软件架构师与系统分析师:快速将设计描述转化为可归档的标准 UML 文档
  • 技术写作与文档工程师:生成与 uml-diagrams.org 风格一致的插图
  • 敏捷开发团队:在代码评审、RFC 文档中嵌入版本化的图表源码
  • 高校教学场景:强制严格 UML 规范,避免学生使用彩色装饰性图示

常规风险提示

  • 隐私泄露:误用 --use-public-server 可能导致内部系统架构、主机名、API 端点等暴露给第三方服务
  • 路径遍历:确保输入 .puml 路径与输出目录可控,避免脚本参数被注入恶意 shell 命令
  • 字体渲染失败:CJK 环境需提前验证 fc-list :lang=zh 输出,否则出现 tofu 占位符
  • 版本兼容性:skinparam 与 CSS-style <style> 两种配置语法不可混用,需根据 PlantUML 版本择一

Plantuml 内容

scripts文件夹
手动下载zip · 36.8 kB
generate-plantuml.ps1text/plain
请选择文件