skills.rest
stevenengland
stevenenglandCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-with-mermaid

Standardize project documentation with Mermaid diagrams and Markdown frontmatter.

Updated Mar 24, 2026
Search Tags:#workflow#documentation#markdown#mermaid#adr#docs#diagrams
One-click install
npx skills add https://github.com/stevenengland/sten-agent-skills --skill documentation-with-mermaid
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-with-mermaid
Source: https://github.com/stevenengland/sten-agent-skills/tree/main/skills/documentation-with-mermaid
Command: npx skills add https://github.com/stevenengland/sten-agent-skills --skill documentation-with-mermaid

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about documentation-with-mermaid

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize documentation patterns across multiple projects?▼

Standardize documentation patterns by enforcing Mermaid diagrams for visual structure, Markdown frontmatter for metadata, and defined governance rules for doc quality checks across ADRs, changelogs, and API references.

What is diagram-first documentation and when should I use it?▼

Diagram-first documentation reduces prose overhead by representing structure and relationships visually using Mermaid. Use it for ADRs, changelogs, docstrings, and API references to improve reader comprehension of complex project architecture.

How do I write architecture decision records using Mermaid diagrams?▼

Write architecture decision records using provided templates that require Mermaid diagrams to outline architectural flow and Markdown frontmatter to capture metadata, ensuring standardized and visually clear decision documentation.

Can I use Markdown frontmatter for doc governance and quality checks?▼

Yes, use Markdown frontmatter to embed standardized metadata across ADRs and changelogs, enabling defined governance workflows and consistent doc quality checks throughout the documentation lifecycle.

What's the best way to document API references without excessive prose?▼

The best way to reduce prose in API references is applying diagram-first documentation with Mermaid to visualize API structure and endpoints, guided by standardized naming conventions and lifecycle documentation patterns.

Does this documentation approach work for both changelogs and docstrings?▼

Yes, this approach provides standardized templates and Mermaid diagram guidance for both changelogs and docstrings, ensuring consistent documentation quality and structural clarity across different project documentation types.

Related Skills

Explore More Content & Communication Skills→
fuzzy-dynamicsfuzzy-dynamics
1

markdown-mermaid-writing

Generate and validate Markdown documents with Mermaid diagrams using templates.

Official
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
nano-stepnano-step
3

mermaid-validator

Validate Mermaid diagram syntax in Markdown files using a Node.js script.

Official
Intermediate
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate