Skip to content

Agent skill that turns natural language, code, Terraform/K8s, SQL, OpenAPI, AsyncAPI, Protobuf and GraphQL sources into editable, tested draw.io architecture diagrams: incremental sync, multi-view projection, drift diff, CI architecture tests, whiteboard derasterize, interactive HTML/PPTX/Mermaid exports.

docs: harmonize README front matter with sibling skills

Agents365-aic7eb26487c92
diff --git a/README.md b/README.md
index 0f99f82..b39eb37 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,21 @@
<img src="assets/workflow.png" width="900" alt="Workflow">
</p>
+A skill that turns natural-language descriptions into `.drawio` XML and exports them to PNG / SVG / PDF / JPG via the native draw.io desktop CLI — with 6 diagram presets (ERD, UML Class, Sequence, Architecture, ML/DL, Flowchart), self-check + auto-fix (2 rounds), an iterative feedback loop (5 rounds), and style presets you can capture from a sample file or image.
+
+Works with Claude Code, Cursor, Copilot, OpenClaw, Codex, Hermes, and any agent that supports the [Agent Skills](https://agentskills.io) format.
+
+## Documentation
+
+| Doc | What's inside |
+|---|---|
+| [COMPARISON.md](COMPARISON.md) | Side-by-side tables vs. native agents and other draw.io skills/tools, with key-advantages summary |
+| [INSTALL_CLI.md](INSTALL_CLI.md) | draw.io desktop CLI install recipes for macOS / Windows / Linux |
+| [INSTALL_SKILL.md](INSTALL_SKILL.md) | Plugin marketplace, manual clone, and update commands |
+| [USAGE.md](USAGE.md) | Natural-language prompts, microservices walkthrough, topology demos (star / layered / ring) |
+| [STYLE_PRESETS.md](STYLE_PRESETS.md) | Built-in presets, "learn my style from a file" workflow, manage-presets commands |
+| [skills/drawio-skill/SKILL.md](skills/drawio-skill/SKILL.md) | Workflow guide loaded by the agent |
+
## What it does
| Capability | Description |
@@ -17,10 +32,6 @@
| Style presets | Capture your visual style from a `.drawio` file or image, save by name, reapply on demand |
| Auto-trigger | Activates whenever diagrams would help explain complex systems |
-## Comparison
-
-See [COMPARISON.md](COMPARISON.md) for side-by-side tables vs. native agents and vs. other draw.io skills/tools (jgraph/drawio-mcp, bahayonghang/drawio-skills, GBSOSS/ai-drawio), plus the key-advantages summary.
-
## Supported diagram types
| Category | Examples | Notable features |
@@ -32,20 +43,16 @@ See [COMPARISON.md](COMPARISON.md) for side-by-side tables vs. native agents and
| Data | ER diagrams, data flow diagrams (DFD) | Table containers, PK/FK notation |
| Other | org charts, mind maps, wireframes | — |
-## Installation
-
-Two steps — install the draw.io CLI first, then drop the skill into your host:
-
-1. **[Install draw.io desktop](INSTALL_CLI.md)** — per-platform recipes for macOS / Windows / Linux.
-2. **[Install the skill](INSTALL_SKILL.md)** — plugin marketplace (recommended), manual clone, and update commands.
-
-## Usage
+## Quick Start
-See [USAGE.md](USAGE.md) for natural-language prompts, a microservices walkthrough, and topology demos (star / layered / ring).
+Two steps — install the draw.io CLI first (see [INSTALL_CLI.md](INSTALL_CLI.md)), then drop the skill into your host (see [INSTALL_SKILL.md](INSTALL_SKILL.md)). After that, just describe what you want:
-## Style Presets
+```
+Create a microservices e-commerce architecture with API Gateway, auth/user/order/product/payment services,
+Kafka message queue, notification service, and separate databases for each service
+```
-See [STYLE_PRESETS.md](STYLE_PRESETS.md) for the built-in presets (`default` / `corporate` / `handdrawn`), the "learn my style from a file" workflow, and the full set of manage-presets commands.
+The skill plans the layout, generates the `.drawio` XML, exports to your chosen format, self-checks, and lets you iterate.
## Community
diff --git a/README_CN.md b/README_CN.md
index 14a1af7..8687ba9 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -1,4 +1,4 @@
-# drawio-skill — From Text to Professional Diagrams
+# drawio-skill —— 从文字到专业图表
[English](README.md) | [Online Docs](https://agents365-ai.github.io/drawio-skill/)
@@ -6,46 +6,53 @@
<img src="assets/workflow-cn.png" width="900" alt="工作流程">
</p>
+一个把自然语言描述变成 `.drawio` XML,并通过 draw.io 桌面版原生 CLI 导出 PNG / SVG / PDF / JPG 的技能 —— 内置 6 种图表预设(ER 图、UML 类图、序列图、架构图、ML/DL、流程图)、自检 + 自动修复(2 轮)、迭代反馈循环(5 轮),以及可以从样例文件或图片学习的样式预设。
+
+支持 Claude Code、Cursor、Copilot、OpenClaw、Codex、Hermes 等任何兼容 [Agent Skills](https://agentskills.io) 规范的 agent。
+
+## 文档导航
+
+| 文档 | 内容 |
+|---|---|
+| [COMPARISON_CN.md](COMPARISON_CN.md) | 与原生智能体、其他 draw.io skills/工具的对照表与核心优势 |
+| [INSTALL_CLI_CN.md](INSTALL_CLI_CN.md) | macOS / Windows / Linux 各平台的 draw.io 桌面版 CLI 安装配方 |
+| [INSTALL_SKILL_CN.md](INSTALL_SKILL_CN.md) | 插件市场、手动克隆与更新命令 |
+| [USAGE_CN.md](USAGE_CN.md) | 自然语言提示词、微服务示例、多种拓扑演示(星形 / 分层 / 环形) |
+| [STYLE_PRESETS_CN.md](STYLE_PRESETS_CN.md) | 内置预设、"从文件学习样式"流程、完整的预设管理命令 |
+| [skills/drawio-skill/SKILL.md](skills/drawio-skill/SKILL.md) | agent 加载的工作流指南 |
+
## 功能说明
| 能力 | 说明 |
|---|---|
| `.drawio` XML 生成 | 根据自然语言描述生成 |
-| 多格式导出 | PNG / SVG / PDF / JPG,使用 draw.io 桌面版原生 CLI |
+| 多格式导出 | PNG / SVG / PDF / JPG,使用 draw.io 桌面版原生 CLI |
| 6 种图表类型预设 | ERD、UML 类图、序列图、架构图、ML/深度学习、流程图 |
| 迭代审查 | 自检 + 自动修复(最多 2 轮),再走 5 轮反馈循环直到你满意 |
| 样式预设 | 用 `.drawio` 文件或图片"教会"Skill 你的风格,命名保存后随时复用 |
| 自动触发 | 图表有助于解释复杂系统时自动调用 |
-## 对比
-
-参见 [COMPARISON_CN.md](COMPARISON_CN.md) —— 与原生智能体、其他 draw.io skills/工具(jgraph/drawio-mcp、bahayonghang/drawio-skills、GBSOSS/ai-drawio)的对照表,以及核心优势小结。
-
## 支持的图表类型
| 类别 | 示例 | 特色 |
|---|---|---|
-| 架构图 | 微服务、云(AWS/GCP/Azure)、网络拓扑、部署 | 分层泳道、hub 居中策略 |
+| 架构图 | 微服务、云(AWS/GCP/Azure)、网络拓扑、部署 | 分层泳道、hub 居中策略 |
| ML / 深度学习 | Transformer、CNN、LSTM、GRU | 张量形状标注、层类型配色 |
-| 流程图 | 业务流程、工作流、决策树、状态机 | 语义形状(平行四边形 I/O、菱形判断) |
-| UML | 类图、序列图 | 继承 / 组合 / 聚合箭头;生命线 + 激活框 |
+| 流程图 | 业务流程、工作流、决策树、状态机 | 语义形状(平行四边形 I/O、菱形判断) |
+| UML | 类图、序列图 | 继承 / 组合 / 聚合箭头;生命线 + 激活框 |
| 数据图 | ER 图、数据流图(DFD) | 表容器、PK/FK 标记 |
| 其他 | 组织架构图、思维导图、线框图 | — |
-## 安装
-
-两步 —— 先装 draw.io CLI,再把技能加载到 host:
-
-1. **[安装 draw.io 桌面版](INSTALL_CLI_CN.md)** —— macOS / Windows / Linux 各平台配方。
-2. **[安装技能](INSTALL_SKILL_CN.md)** —— 插件市场(推荐)、手动克隆、以及更新命令。
-
-## 使用方式
+## 快速开始
-参见 [USAGE_CN.md](USAGE_CN.md) —— 包含自然语言提示词、微服务示例,以及多种拓扑演示(星形 / 分层 / 环形)。
+两步 —— 先装 draw.io CLI(见 [INSTALL_CLI_CN.md](INSTALL_CLI_CN.md)),再把技能加载到 host(见 [INSTALL_SKILL_CN.md](INSTALL_SKILL_CN.md))。装好之后直接描述你想要的:
-## 样式预设
+```
+画一个微服务电商架构图,包含 API Gateway、用户/订单/商品/支付服务、
+Kafka 消息队列、通知服务,以及各自独立的数据库
+```
-参见 [STYLE_PRESETS_CN.md](STYLE_PRESETS_CN.md) —— 包含内置预设(`default` / `corporate` / `handdrawn`)、"从文件学习样式"流程,以及完整的预设管理命令。
+技能会规划布局、生成 `.drawio` XML、导出为你选择的格式、自检,然后让你迭代。
## 社区
@@ -60,7 +67,7 @@
## 支持作者
-如果这个 skill 对你有帮助,欢迎支持作者:
+如果这个 skill 对你有帮助,欢迎支持作者:
<table>
<tr>
@@ -94,6 +101,6 @@
- Bilibili: https://space.bilibili.com/441831884
- GitHub: https://github.com/Agents365-ai
-## 开源协议
+## License
MIT