documentation-with-mermaid

Community

Diagram-first docs to clarify any project.

Authorstevenengland
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Diagram-first documentation patterns reduce prose overhead and improve comprehension by representing structure and relationships with diagrams, especially using Mermaid.

Core Features & Use Cases

  • Mermaid-based diagrams for API references, processes, architecture, and references
  • Guidance on documentation lifecycle, naming conventions, and doc quality checks
  • Templates and examples for ADRs, changelogs, docstrings, and reference material

Quick Start

Choose your documentation target and begin drafting using Mermaid diagrams to outline structure and flow.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-with-mermaid
Download link: https://github.com/stevenengland/sten-agent-skills/archive/main.zip#documentation-with-mermaid

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.