SuperAPI AI 工具集

dotnet-mermaid-diagrams

部署与运维

查看项目

更新于 10-16 02:33

技能介绍

用途:为 .NET 项目编写 Mermaid 图表,把架构与流程以图表即代码方式表达,便于在 Markdown、Issue、PR 与讨论中渲染。

主要能力:架构图(C4 风格上下文/容器/组件、分层架构、微服务拓扑);时序图(API 请求流、async/await、中间件管道、OAuth 2.0/OIDC 认证流);类图(领域模型、DI 注册图、继承与接口实现);部署图(容器、Kubernetes Pod、CI/CD 流程);ER 图(EF Core 关系、数据库模式);状态图(订单处理、Saga、状态机);流程图(框架选型、架构决策)。

使用方式:在 Markdown 围栏代码块中使用 mermaid 标识符;节点 ID 用 PascalCase,标签可带技术名,用 <br/> 换行;用 subgraph 按层、部署边界或团队分组,嵌套不超过 2 层;建议使用中性主题 %%{init: {'theme': 'neutral'}}%% 以兼容明暗模式;提交前用 Mermaid Live Editor(https://mermaid.live)验证语法。

适用场景:.NET 8.0+ 项目的架构文档、API 流程说明、EF Core 模型可视化与部署拓扑描述;Mermaid v10+ 环境(GitHub、Starlight、Docusaurus 原生支持)。

限制:不负责文档平台的 Mermaid 渲染配置、GitHub 文档结构与 README 模式、文档站点 CI/CD 部署;图表建议不超过约 50 个节点,时序图不超过 8 个参与者,类图 10-15 个类,ER 图 10-12 个实体;ER 关系使用 Mermaid 语法而非 UML 多重性;GitHub 不加载 Font Awesome,勿用图标语法;嵌套泛型需 Mermaid v10.3+。完整示例见该技能目录的 examples.md。