安装
git clone https://github.com/SpillwaveSolutions/design-doc-mermaid.git适合谁
适合要在 Claude Code 里画 Mermaid 图、写设计文档的人。官方写明:这是一套强大的 Claude Code 技能,用按需加载指南、从代码生成图,以及 Python 工具,来创建 Mermaid 图和设计文档。
更合适的人,是已经有一段流程(例如注册加邮箱验证)或已有代码、想先看成图的人。不适合还没准备好把仓库克隆进 ~/.claude/skills 的人。
开始前要能使用 git clone,并接受官方给出的这一条手工安装路径。不要一上来混用另一套市场命令。
3 分钟完成第一次尝试
只走原文的克隆安装。第一次先在对话里出图,不要先往仓库写设计文档。
前置条件:本机已有 git,并且 Claude Code 会从 ~/.claude/skills 加载技能。第一次不要对生产文档做覆盖。
安装位置:先进入技能目录,再克隆官方仓库。
cd ~/.claude/skills
git clone https://github.com/SpillwaveSolutions/design-doc-mermaid.git
官方仓库页:
https://github.com/spillwavesolutions/design-doc-mermaid
低风险触发:安装后,在对话里使用原文示例句:Create an activity diagram for user registration with email verification。先要求只在对话中给出 Mermaid,不写文件。官方把 SKILL.md 写成带决策树的主协调文件;若助手开始调用未点名的脚本,先确认副作用。
成功信号:~/.claude/skills/design-doc-mermaid 已存在且含 SKILL.md,对话里出现活动图的 Mermaid。若要保存成文档,先确认路径再写。
使用案例
案例一:按官方示例画活动图。对助手说 Create an activity diagram for user registration with email verification。适合要描述注册并验证邮箱流程的人。证据只给出这一句用户话,没有写出指南文件名。先在对话里看图,再决定是否落盘。
案例二:从已有代码生成图。官方能力包括 code-to-diagram generation。适合已经有代码、想先看成图的人。证据没有说明支持哪些语言、会不会改源码。只对你自己的代码做只读生成;若 Python 工具要写文件,先确认输出位置。
使用边界
主路径是克隆到 ~/.claude/skills。原文另有 skilz install SpillwaveSolutions_design-doc-mermaid/design-doc-mermaid。第一次不要两条一起做,也不要把市场命令套到未写明的环境。
点名的文件只有 SKILL.md(主协调、带决策树)。其他指南名、脚本名或技能路径不要自行补全。
按需加载指南和 Python 工具被提到,但没有列出清单。不要假设它会自动安装 Mermaid 运行时或发布文档。
官方只把这套技能写成 Claude Code 技能,没有为其他环境给出步骤。