Install and use the Skill
Install the Skill
Install the repository with its guides, templates and optional utilities.
npx skills add SpillwaveSolutions/design-doc-mermaidDescribe the diagram
Provide the workflow or project files and specify the intended audience and diagram type.
Create a Mermaid sequence diagram explaining how a customer places an order, including payment failure and confirmation paths.
About this Skill
Choose a diagram type, read its bundled guide, and produce Mermaid source or a design document from a description or existing project.
Why we picked it
Provides guides for activity, deployment, architecture and sequence diagrams, plus document templates and optional conversion utilities.
What it helps with
- Explain a workflow, deployment, API interaction or system design in a Markdown document.
Scope and limitations
The output is Mermaid source or a Markdown design document. Image exports and syntax checks depend on the separately installed Mermaid CLI.
The upstream README states MIT, but the reviewed repository does not include a separate license file. Check the upstream terms before redistributing its files.
Before you use it
- A coding agent that can read the Skill and its bundled guides. The optional extraction and image-conversion scripts require Python; rendering or syntax validation additionally requires Mermaid CLI.
Sources & references
Original sources are linked below. Practical starting points are editorial suggestions from SkillHey.
