Mermaid Architect

SpillwaveSolutions/design-doc-mermaid

Create Mermaid diagrams and design documents from requirements or source code using focused reference guides.

Contenu mis à jour:

Voir sur GitHub
npx skills add SpillwaveSolutions/design-doc-mermaid
184Étoiles24ForksDernier push du dépôt

Install and use the Skill

  1. Install the Skill

    Install the repository with its guides, templates and optional utilities.

    npx skills add SpillwaveSolutions/design-doc-mermaid
  2. Describe 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.

À propos de ce Skill

Choose a diagram type, read its bundled guide, and produce Mermaid source or a design document from a description or existing project.

Pourquoi ce choix

Provides guides for activity, deployment, architecture and sequence diagrams, plus document templates and optional conversion utilities.

À quoi il sert

  • 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.

Avant de l’utiliser

  • 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 et références

Les sources originales sont liées ci-dessous. Les pistes pratiques sont des suggestions de la rédaction de SkillHey.