Doc Illustrator

为技术文档生成Mermaid插图,支持模板匹配和LLM自主设计

zht043 Updated

File contents

doc-illustrator

概述

分析技术文档,生成Mermaid插图,用户确认后替换。混合模板匹配与LLM理解两条路径。

适用场景

  • 技术文档中需要添加或改进可视化插图
  • 将ASCII图表升级为Mermaid格式

运行环境

  • 跨平台:Windows、macOS、Linux(纯文本处理,无平台依赖)

风格规范

主题配置(每个图表头部必须包含)

---
config:
  look: neo
  theme: default
---

不硬编码颜色,由渲染平台(GitHub/GitLab等)根据用户dark/light偏好自动适配。

视觉规则

节点形状: 一般节点圆角 (["文本"]),决策节点菱形 {"条件"},环境/容器类用方括号 ["文本"]

图标: 每个节点加图标增强辨识度。入口🚀 完成✅ 失败❌ 执行⚡ 搜索🔍 配置⚙️ 导入📥 补丁🩹 替换🔄 拦截🚫 组件📦 目标🎯 优化✨ 用户👤 检查🔐 回退🔙。subgraph标题也带图标。

文本: 关键词 <b>加粗</b>,补充说明 <small>小字</small>,代码 <code>代码</code>,换行 <br/>

箭头: 正常流程 -->,虚拟关系 -.->,并列汇聚 A & B --> C,无连接 A ~~~ B

流程步骤

1. 分析文档

读取目标文档,识别所有插图(ASCII块、旧图表)及上下文。产出:插图清单(位置、章节、类型初判)。

2. 逐图设计

模板匹配路径: 匹配templates/下YAML模板的关键词和结构模式,基于guidance生成代码。

LLM理解路径(模板不适配时): 提取概念和关系,判定类型(层次/顺序/转换/包含),自主设计。

3. 展示候选

写入项目目录的preview/供预览。用户选择:满意/重新生成/修改建议。

4. 应用修改

替换原文档插图区域,清理preview/临时文件。

5. 模板沉淀(可选)

LLM方案被采纳后可保存为新模板。

注意事项

  • 每个图表头部包含完整config块
  • 替换时精确匹配原插图起止行
  • 图表文本与文档语言一致
  • 预览文件放项目目录preview/下,不放skill目录

Token约束

  • Mermaid代码:生成后不重复粘贴,只确认已写入文件
  • 文档内容:只读取必要部分,不全文复制
  • 重复信息:不复述已知内容

zht043/AgentSkills/tree/main/skills/doc-illustrator commit b562233dc0

Frequently asked questions

npx skillmds@latest add zht043/doc-illustrator