design-doc-mermaid
The design-doc-mermaid skill generates Mermaid diagrams and design documentation from text descriptions or source code. It provides specialized guides for activity, deployment, architecture, and sequence diagrams, alongside Python utilities for diagram extraction, validation, and image conversion.
Is design-doc-mermaid safe to install?
Review the source first: our audit of design-doc-mermaid's source files found 4 shell commands, 0 external URLs, file reads and writes (high risk). Every command and URL listed appears verbatim in the skill's source. The skill executes local Python scripts and shell commands to process files, validate diagrams, and perform image conversions. It reads and writes files to the local filesystem.
How we audit skills: our security review methodology.
Who is this skill for?
Developers, system architects, and technical writers who need to document software architecture, workflows, and API interactions using Mermaid diagrams.
What can you do with it?
- Generating activity diagrams for business logic and workflows
- Creating deployment diagrams for cloud infrastructure
- Documenting system architecture and component design
- Extracting diagrams from existing codebases
- Converting Mermaid code to PNG or SVG images
- Creating design documents using predefined templates
How good is this skill?
Quality score: 9/10. The skill provides a comprehensive, structured approach to diagram generation with clear workflows and utility scripts. The documentation is highly specific regarding file paths and usage patterns.
What does the skill file contain?
# Mermaid Architect - Hierarchical Diagram and Documentation Skill Mermaid diagram and documentation system with specialized guides and code-to-diagram capabilities. ## Table of Contents - [Decision Tree](#decision-tree) - [Available Guides and Resources](#available-guides-and-resources) - [Usage Patterns](#usage-patterns) - [Resilient Workflow](#resilient-workflow) - [Unicode Semantic Symbols](#unicode-semantic-symbols) - [Python Utilities](#python-utilities) - [Decision Tree Examples](#decision-tree-examples) - [High-Contrast Styling](#high-contrast-styling) - [File Organization](#file-or...
Frequently asked questions
How does the skill handle diagram validation?
The skill uses the mmdc command-line tool or the resilient_diagram.py script to validate Mermaid syntax before adding diagrams to documentation.
Can the skill convert diagrams to images?
Yes, the skill uses the mermaid_to_image.py script to convert .mmd files into PNG or SVG formats.
What happens if a diagram fails validation?
The resilient workflow triggers an error recovery process that checks the troubleshooting guide, performs searches, and attempts to fix the syntax.
Related skills
github-actions-docs
264.6KDevelopers and DevOps engineers working with GitHub Actions workflows
The github-actions-docs skill provides grounded answers to GitHub Actions queries by retrieving information from official GitHub documentation. It assists with workflow syntax, security, migration, and runner configuration.
brainstorming
256.4KDevelopers and project managers who need to define requirements, architecture, and design for software projects before writing code
A structured brainstorming framework that guides users through project exploration, design proposal, and specification before implementation. It enforces a strict design-first workflow, requiring user approval for designs and documentation before transitioning to the writing-plans skill.
simple
221.4KDevelopers and project managers who need a fast, lightweight decision-making process for feature design or component creation
A structured brainstorming framework for architectural and creative tasks that guides users from discovery to decision-making through a defined process flow.
paper-context-resolver
140.4KDevelopers and researchers performing deep learning repository reproduction who encounter specific technical ambiguities in documentation
The paper-context-resolver skill provides targeted information from research papers to resolve specific gaps in deep learning repository reproduction. It focuses on technical details like dataset splits, preprocessing steps, evaluation protocols, checkpoint mappings, and runtime assumptions.