Mermaid流程图时序图UML文档工程团队规范
Mermaid 图表速成与规范：流程图、时序图、类图到甘特图
文档即代码，图表也该“可版本化”。Mermaid 以简洁文本语法描述常用图表，在评审/迭代频繁的团队里尤其高效：Diff 好看、协作顺畅、导出方便。本文从 0-1 过一遍常用类型与语法片段，并给出团队可落地的“小约定”。
一、常用类型与示例
- 流程图 flowchart：节点与箭头描述流程，支持条件与子图；
- 时序图 sequenceDiagram：参与者、消息与时序；
- 类图 classDiagram：类、属性、方法与关系；
- 状态图 stateDiagram：状态与转移；
- ER 图 erDiagram：实体、关系、多重性；
- 甘特图 gantt：任务、起止时间、依赖。
在线编辑器提供模板与实时预览，能快速验证语法效果，导出 SVG/PNG 即可入库或进文档。
二、团队小约定
- 统一主题（浅/深），对外导出时保持一致；
- 命名规范：英文小写连字符，中文在标签里展示；
- 流程分层：复杂流程拆子图，避免“全在一张图”；
- 语义优先：先保证关系清晰，再追求样式；
- 与评审配合：PR 附上图表片段或导出图，便于对齐理解。
三、导出与嵌入
Mermaid 支持一键导出 SVG/PNG。SVG 更适合版本化与缩放，PNG 适合轻量分享。若要嵌入网页，可结合静态资源管理或以代码块直接渲染。
四、常见问题
- 文字重叠：适当调整布局或换行；
- 连线过密：拆子图；
- 图太长：改为横向或切分；
- 黑暗主题：注意对比度，确保投屏可读。
🔗 相关工具
- 在线Mermaid图表编辑器 - 即写即看、模板齐全、导出 SVG/PNG、支持暗色主题