describe-design

Research codebase architecture and produce structured design documents with Mermaid diagrams.

Updated Apr 8, 2026
One-click install
npx skills add https://github.com/LudwigAJ/swell --skill describe-design-ludwigaj
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describe-design
Source: https://github.com/LudwigAJ/swell/tree/main/.claude/skills/describe-design
Command: npx skills add https://github.com/LudwigAJ/swell --skill describe-design-ludwigaj

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams understand how a feature or system works by turning source code into a clear architectural document, reducing onboarding time and making complex implementations easier to explain.

Core Features & Use Cases

  • Architecture Research: Investigates a codebase to identify entry points, dependencies, and component boundaries.
  • Design Documentation: Produces a structured markdown document with diagrams, data flow, configuration, and code references.
  • Use Case: A developer needs to explain a subsystem to teammates or AI agents and wants a durable, human-readable design overview instead of scattered notes.

Quick Start

Ask the assistant to research the target feature or system in your codebase and draft an architecture document with diagrams and stable code references.

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 an existing codebase?

To generate architecture documentation, you can use a Skill that researches your codebase to identify entry points and dependencies, then produces a structured markdown document with Mermaid diagrams and stable code references.

What's the best way to create an onboarding guide for a complex software system?

Creating an onboarding guide for a complex software system is best handled by analyzing source code to extract component boundaries and data flow, yielding a clear architectural overview that reduces onboarding time.

How do I document component interactions and data flow in a feature?

To document component interactions and data flow in a feature, research the codebase architecture and compile a structured design document that includes clear explanations and Mermaid diagrams.

Can I automatically generate Mermaid diagrams for my codebase architecture?

Yes, you can automatically generate Mermaid diagrams for your codebase architecture by investigating the source code to map dependencies and component boundaries, which are then rendered into a structured design document.

Does this architecture documentation approach work for internal knowledge transfer?

Yes, this approach works for internal knowledge transfer by turning scattered source code into a durable, human-readable design overview that clearly explains system interactions, configuration, and persistence.

Do I need any specific dependencies to research a codebase and produce a design document?

No specific dependencies are required to research a codebase and produce a design document, as the process relies on standard codebase exploration to generate structured markdown with stable file and symbol references.