架构与流程图表生成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/architecture-diagram-gen。
技能介绍
问题:文档里的图总是对不上代码
架构文档里最常见的失败不是缺少图,而是图与实现脱节。手绘的 C4 草图在评审时看起来够用,三个月后组件改名、依赖反转、新增了消息队列,那张图还留在 Wiki 里被反复引用。新人照着图去理解系统,结果在真实代码里找不到对应的包和接口,只能反过来再读一遍源码。
另一个问题是表达混杂。一张图里同时画了部署拓扑、调用关系和数据流转,读者没法判断箭头到底代表 RPC 还是事件投递。
技能如何工作
这个技能把角色固定为技术可视化设计师,核心约束是一张准确的图胜过千字描述。它覆盖四类图:
架构图:表达组件与依赖流程图:表达步骤与分支时序图:表达跨对象交互数据流图:表达数据如何流转
生成流程是四步,每步都对应一个容易出错的环节:
- 先明确「给谁看、说明什么关系」,避免一张图承载多种语义
- 提供真实组件名与接口,不用
ServiceA、ModuleB这类占位符 - 由智能体产出自包含 HTML,可离线打开,不依赖外部 CDN 或字体
- 人工核对节点与箭头是否准确
配套的检查清单要求图只表达一种关系、节点命名与代码一致、可离线打开或导出、关键依赖方向已标注。常见陷阱也写得很直接:图塞太多关系就拆成多张;占位名会误导读者,必须用真实命名;先对后美,不要只看美观忽略准确性。
适用边界
这个技能是文档可视化参考,不是架构决策工具。AI 输出的图不能替代架构评审与事实核对,图表必须与真实系统保持一致。如果你的系统本身边界模糊,建议先完成设计评审再画图,否则图只会把混乱固化下来。
使用场景
- 接手陌生项目,需要快速画出系统架构图作为新人 onboarding 材料
- 设计评审前要梳理跨服务时序关系,避免口述遗漏关键交互步骤
- 编写技术方案文档,需要用流程图说明核心业务流程的分支逻辑
- 重构前要梳理数据流走向,确认各模块之间的数据传递是否合理
适合人员
- 后端工程师,需要在重构前输出与代码一致的依赖关系图
- 技术负责人,要在方案评审中用准确图表替代口头描述
- 系统架构师,需要持续维护文档使其与实际部署保持同步
- 技术写作者,需要为教程和文档生成风格统一的可视化素材