describe-design

Research codebase architecture and generate Markdown documentation with Mermaid diagrams.

33|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/bbtheo/cuplyr --skill describe-design-bbtheo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describe-design
Source: https://github.com/bbtheo/cuplyr/tree/main/.claude/skills/describe-design
Command: npx skills add https://github.com/bbtheo/cuplyr --skill describe-design-bbtheo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you understand and document complex codebases by researching their architecture, making it easier for developers and AI agents to grasp how systems work.

Core Features & Use Cases

  • Codebase Research: Explores directory structures, READMEs, and configuration files to build a mental model.
  • Architectural Documentation: Generates Markdown documents with diagrams and code references.
  • Use Case: Onboarding a new developer to a large project by providing a clear, documented overview of its main components and their interactions.

Quick Start

Use the describe-design skill to research and document the architecture of the 'cuplyr' codebase.

Frequently Asked Questions about describe-design

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

FAQPage Schema
How do I document codebase architecture for developer onboarding?

You document codebase architecture by researching directory structures and configuration files to generate human-readable Markdown with Mermaid diagrams and stable code references. This workflow produces onboarding materials that explain system interactions and main components to new developers.

What is the best way to generate Mermaid diagrams for a codebase overview?

Generating Mermaid diagrams for a codebase overview involves a multi-stage workflow of scope definition, exploration, and deep research. The process outputs Markdown documents containing architectural diagrams and stable code references that map how system components interact.

Can I research and document specific feature architecture within a large project?

Yes, you can research and document specific feature architecture by defining the exploration scope before analyzing the codebase. The multi-stage drafting process supports generating targeted feature documentation and system overviews with accurate code references.

How does codebase research work for knowledge transfer between developers?

Codebase research for knowledge transfer works by exploring READMEs and configuration files to build a mental model of the system. It produces human-readable Markdown documentation that captures architectural interactions, making complex systems easier for developers and AI agents to grasp.

Does architectural documentation require external dependencies to generate Markdown?

No external dependencies are required to generate Markdown architectural documentation. The research workflow operates independently to explore the codebase and output human-readable Markdown files with Mermaid diagrams and stable code references.