design-doc-mermaid

5 stars 2 forks
87
B

Create Mermaid diagrams (activity, deployment, sequence, architecture) from text descriptions or source code. Use when asked to "create a diagram", "generate mermaid", "document architecture", "code to diagram", "create design doc", or "convert code to diagram". Supports hierarchical on-demand guide loading, Unicode semantic symbols, and Python utilities for diagram extraction and image conversion.

#diagram#design#guide#document#diagrams#diagram guides#Load#Design Document

Third-Party Agent Skill: Review the code before installing. Agent skills execute in your AI assistant's environment and can access your files. Learn more about security

Installation for Agentic Skill

View all platforms →
skilz install SpillwaveSolutions/design-doc-mermaid/design-doc-mermaid
skilz install SpillwaveSolutions/design-doc-mermaid/design-doc-mermaid --agent opencode
skilz install SpillwaveSolutions/design-doc-mermaid/design-doc-mermaid --agent codex
skilz install SpillwaveSolutions/design-doc-mermaid/design-doc-mermaid --agent gemini

First time? Install Skilz: pip install skilz

Works with 22+ AI coding assistants

Cursor, Aider, Copilot, Windsurf, Qwen, Kimi, and more...

View All Agents
Download Agent Skill ZIP

Extract and copy to ~/.claude/skills/ then restart Claude Desktop

1. Clone the repository:
git clone https://github.com/SpillwaveSolutions/design-doc-mermaid
2. Copy the agent skill directory:
cp -r design-doc-mermaid ~/.claude/skills/

Need detailed installation help? Check our platform-specific guides:

Related Agentic Skills

Agentic Skill Details

Stars
5
Forks
2
Type
Non-Technical
Meta-Domain
general
Primary Domain
general
Sub-Domain
javascript react code
Market Score
87

Agent Skill Grade

B
Score: 87/100 Click to see breakdown

Score Breakdown

Spec Compliance
13/15
PDA Architecture
26/30
Ease of Use
23/25
Writing Style
8/10
Utility
18/20
Modifiers: -1

Areas to Improve

  • Inline examples inflate token usage
  • Redundant content between sections
  • File Organization shown twice

Recommendations

  • Add trigger phrases to description for discoverability
  • Add table of contents for files over 100 lines

Graded: 2026-01-19

Developer Feedback

I took a look at your design-doc-mermaid skill and wanted to share some thoughts.

Links:

The TL;DR

You're at 87/100, solid B territory. This is based on Anthropic's best practices for agent skills. Your strongest area is Ease of Use (23/25) – the trigger phrases, decision tree, and "When to Use What" table are chef's kiss. Weakest is Progressive Disclosure Architecture (26/30) – mainly because you're carrying too much weight in SKILL.md itself.

What's Working Well

  • Trigger phrases are dialed in – "create a diagram", "generate mermaid", "code to diagram" – developers will find this skill easily
  • Hierarchical structure is clean – References are organized by diagram type (deployment, architecture, sequence, activity) with clear paths and no guessing
  • Comprehensive troubleshooting guide – 28 documented errors with fixes shows you thought through real problems developers hit
  • Framework examples pay dividends – Spring Boot, microservices, K8s patterns give people immediate wins without hunting for templates

The Big One

Inline examples are killing your token efficiency. You've got three complete, styled Mermaid diagrams embedded directly in SKILL.md (Infrastructure, Activity Flow, Microservices sections). Every time someone invokes this skill, they're loading those diagrams even if they don't need them.

The fix: Move the detailed styled examples to references/guides/unicode-symbols/guide.md where they belong, and keep just one minimal example in SKILL.md to show the concept. This single change gets you +2 points and makes the skill snappier for real-world use.

Other Things Worth Fixing

  1. **Resilient workflow is ...

AI-Detected Topics

Extracted using NLP analysis

diagram design guide document diagrams diagram guides Load Design Document API Design Unicode Symbols

Report Security Issue

Found a security vulnerability in this agent skill?