Mermaid 架构与文档

SpillwaveSolutions/design-doc-mermaid

根据需求或源代码,使用专题参考指南创建 Mermaid 图表和设计文档。

最近更新于:

查看 GitHub 项目
npx skills add SpillwaveSolutions/design-doc-mermaid
184Stars24Forks仓库最近推送

安装并使用 Skill

  1. 安装 Skill

    安装仓库及其指南、模板和可选工具。

    npx skills add SpillwaveSolutions/design-doc-mermaid
  2. 描述需要的图表

    提供流程说明或项目文件,并说明目标读者和图表类型。

    创建 Mermaid 时序图,说明客户下单流程,并包含支付失败和确认分支。

关于这个 Skill

选择图表类型,阅读配套指南,并根据需求描述或现有项目生成 Mermaid 源码或设计文档。

为什么推荐

提供活动、部署、架构与时序图指南,以及文档模板和可选转换工具。

适合用来做什么

  • 在 Markdown 文档中解释工作流程、部署架构、API 交互或系统设计。

适用范围与限制

输出为 Mermaid 源码或 Markdown 设计文档。图片导出和语法检查依赖另外安装的 Mermaid CLI。

上游 README 标明 MIT,但所审阅的仓库未包含单独的许可证文件。重新分发其文件前请核对上游条款。

使用前需要了解

  • 需要可读取 Skill 及配套指南的编程 Agent。可选的提取和图片转换脚本需要 Python;渲染或语法验证还需要 Mermaid CLI。

资料与来源

原始资料见下方链接;文中的上手建议由 SkillHey 编辑整理。