SuperAPI AI 工具集

docs-with-mermaid

编程与开发

查看项目

更新于 10-16 03:47

技能介绍

用途:该技能面向技术文档写作,强调通过文字与 Mermaid 图表结合,解释系统架构、API 调用流程、数据库模型、状态机、系统交互等复杂内容,帮助读者理解“为什么”再做“是什么”和“怎么做”。

主要能力:可根据文档内容选择合适图表类型,如流程图用于流程与决策逻辑,序列图用于 API 与服务交互,类图用于面向对象设计,状态图用于生命周期与状态机,ER 图用于数据库模式,C4 上下文/容器/组件图用于不同层级的系统架构,用户旅程图、甘特图、象限图、思维导图、时间线、Git 图与饼图等用于特定场景。文档结构建议按概述、关键概念、架构、工作原理、数据模型、API 参考、配置、故障排查组织。

使用方式:作为 Claude Code 技能使用时,在请求创建文档或解释系统时触发;文档中嵌入 Mermaid 代码块即可渲染图表。图表编写遵循从简到繁、命名一致、用 subgraph 分组、用 LR/TB/BT 控制方向、用 note 补充上下文、用颜色区分边界与状态等原则,并附质量检查清单,确认渲染、标签、流向、可访问性、上下文与细节程度。

适用场景:README、API 文档、架构文档、新人入职文档,以及需要可视化请求/响应、状态机、微服务等常见模式的说明。

限制:资料未提供安装命令、收费方式、价格、平台支持、实际效果或具体使用步骤等细节,暂未提供;图表语法需自行确保在目标平台(如 GitHub、GitLab 等)正确渲染。