describe-design

Generate architectural documentation with Mermaid diagrams and stable code references.

1|Updated Feb 17, 2026
One-click install
npx skills add https://github.com/JDenn0514/surveycore --skill describe-design-jdenn0514
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describe-design
Source: https://github.com/JDenn0514/surveycore/tree/main/.claude/skills/describe-design
Command: npx skills add https://github.com/JDenn0514/surveycore --skill describe-design-jdenn0514

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Research teams often struggle to translate complex codebases into approachable architectural docs that support onboarding, reviews, and knowledge transfer.

Core Features & Use Cases

  • Generate architecture overviews from code structure, including component relationships and data flows.
  • Create Mermaid diagrams and stable code references to aid navigation and future maintenance.
  • Produce publish-ready documentation suitable for onboarding, design reviews, and knowledge transfer.

Quick Start

Provide a high-level architectural brief for the selected codebase and include diagrams and 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 architectural documentation from an existing codebase?

Mermaid diagrams for codebase architecture are generated by analyzing system structures and component relationships to produce visual flow representations. The Skill outputs Markdown files containing these diagrams alongside stable code references to aid navigation and future maintenance.

Can I create onboarding materials from code structure for new developers?

Yes, you can create onboarding materials from code structure by running this Skill to translate complex codebases into approachable architectural docs. It produces publish-ready documentation that explains features and system structures, supporting knowledge transfer for new developers.

What is the best way to document component relationships and data flows for a design review?

The best way to document component relationships and data flows for a design review is to generate architecture overviews using this Skill. It produces Markdown with Mermaid diagrams and stable code references, providing a clear visual and textual basis for evaluating system structures.

Does this architectural documentation tool work with any codebase?

Yes, this architectural documentation tool works with a variety of codebases to produce architecture overviews and onboarding materials. It requires no external dependencies or specific components to function, allowing you to apply it directly to your existing repository structure.

Why use Mermaid diagrams and stable code references in architecture overviews?

Mermaid diagrams and stable code references are used in architecture overviews to aid navigation and future maintenance. This combination produces publish-ready Markdown documentation that is approachable for both humans and AI agents, ensuring long-term knowledge transfer.

When do I need to generate architecture overviews from my codebase?

You need to generate architecture overviews from your codebase when research teams struggle to translate complex structures into approachable docs. This process supports onboarding, design reviews, and knowledge transfer by producing clear documentation of features and system structures.