describe-design

Document codebase architectures and generate Mermaid diagrams for system structure.

466|38|Updated Nov 21, 2025
One-click install
npx skills add https://github.com/posit-dev/skills --skill describe-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describe-design
Source: https://github.com/posit-dev/skills/tree/main/posit-dev/describe-design
Command: npx skills add https://github.com/posit-dev/skills --skill describe-design

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Research a codebase and produce an architectural document describing how features or systems work. The output includes Mermaid diagrams and stable code references suitable for humans and AI agents.

Core Features & Use Cases

  • Generate an architecture overview and component relationships for a codebase.
  • Include Mermaid diagrams to visualize architecture and data flows.
  • Provide stable code references and guidance for onboarding and knowledge transfer.

Quick Start

Provide the location of the codebase and your target audience to generate a human- and AI-friendly architecture document.

Frequently Asked Questions about describe-design

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

FAQPage Schema
How do I generate architecture documentation from a codebase for onboarding?

Generate architecture documentation by analyzing the codebase to produce a Markdown document with Overview, Components, Data Flow, Configuration, Code References, and Glossary sections, plus Mermaid diagrams to explain system structure for onboarding and knowledge transfer.

What is the best way to document codebase architecture and data flow for AI agents?

Document codebase architecture by producing a Markdown file containing Mermaid diagrams and stable code references, creating a structured output readable by both humans and AI agents navigating the system structure.

Can I create Mermaid architecture diagrams for software projects across different tech stacks?

Yes, you can create Mermaid architecture diagrams across languages and tech stacks. The process researches the codebase and generates applicable architectural documents and data flow visualizations for any software project.

Does architecture documentation generation work without setting up dependencies or components?

Architecture documentation generation works without dependencies or components. You provide the codebase location and target audience to generate a human- and AI-friendly Markdown document with Mermaid diagrams and a code-reference index.

Why include a code-reference index in codebase architecture docs?

Include a code-reference index in architecture docs to provide stable code references for humans and AI agents. This anchors architectural descriptions to actual codebase locations, supporting accurate knowledge transfer and architectural reviews.