Mermaid Diagrams 说明文档

# Mermaid 图表技能 一份使用 Mermaid 文本语法创建专业软件图表的综合指南。此技能使你能够可视化系统架构、记录代码结构、建模数据库，并通过图表传达技术概念。 ## 目的 将复杂的技术概念转化为清晰、可维护的图表，并可与代码一起进行版本控制。Mermaid 图表由简单的文本定义渲染而成，易于更新、在合并请求中审查并长期维护。 ## 何时使用此技能 当你需要执行以下操作时使用此技能： - **记录架构** - 可视化系统上下文、容器、组件和部署 - **领域建模** - 创建包含实体、关系和行为的领域模型 - **解释流程** - 展示 API 交互、用户旅程、身份验证序列 - **设计数据库** - 记录表关系、键和模式结构 - **规划流程** - 绘制工作流、决策树、算法和流水线 - **沟通设计** - 在编码前与利益相关者就技术决策达成一致 ### 触发短语 当提到以下内容时，该技能会被激活： - "diagram" (图表), "visualize" (可视化), "model" (建模), "map out" (绘制), "show the flow" (展示流程) - "architecture diagram" (架构图), "class diagram" (类图), "sequence diagram" (序列图), "flowchart" (流程图) - "database schema" (数据库模式), "ERD" (实体关系图), "entity relationship" (实体关系) - "system design" (系统设计), "data model" (数据模型), "domain model" (领域模型) ## 工作原理 1. **选择合适的图表类型**，基于你想传达的内容 2. **从核心元素开始** - 实体、参与者或组件 3. **添加关系** - 连接、流程、交互 4. **逐步优化** - 添加细节、样式、注释 5. **导出或嵌入** - 在文档、PR、Wiki 中使用 Mermaid 语法直观，并在所有图表类型中遵循一致的模式： mermaid diagramType definition content ## 关键特性 ### 支持 9 种图表类型 1. **类图** - 领域模型、OOP 设计、实体关系 2. **序列图** - API 流程、用户交互、时间序列 3. **流程图** - 用户旅程、流程、决策逻辑、流水线 4. **实体关系图** - 数据库模式、表关系 5. **C4 架构图** - 系统上下文、容器、组件 6. **状态图** - 状态机、生命周期状态 7. **Git 图** - 分支策略、版本控制流程 8. **甘特图** - 项目时间线、进度安排 9. **饼图/柱状图**