describe-design

Featured

Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and describe a system's design. Produces markdown documents with Mermaid diagrams and stable code references suitable for humans and AI agents.

Web & Frontend 474 stars 42 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
89
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Describe Design Research a codebase and produce an architectural document describing how features or systems work. The output is a markdown file organized for both human readers and future AI agents. ## Workflow ### Stage 1: Scope Definition Understand what to document before exploring: 1. Ask what feature, system, or component to document. 2. Clarify the target audience (developers, AI agents, or both). 3. Confirm the codebase location if not obvious from context. ### Stage 2: Initial Exploration Explore the codebase broadly to build a mental model. Use lightweight, fast exploration methods when available (in Claude Code, for example, use a Haiku Explore subagent): 1. Scan directory structure and identify key entry points. 2. Read README, config files, and existing documentation. 3. Identify the main files and modules related to the feature. 4. Build a mental model of codebase organization. Present a high-level outline to the user: ``` ## Proposed Outline 1. [Component A] - Brief description 2. [Component B] - Brief description 3. [Component C] - Brief description * Have I correctly captured the scope of the research? Reply "yes" to continue. * Otherwise, please let me know what I've misunderstood. ``` When the user confirms the scope, move on to deep research. ### Stage 3: Deep Research For each component in the approved outline: 1. Trace code paths from entry points. 2. Identify dependencies and interactions between components. 3. Note configuration optio...

Details

Author
posit-dev
Repository
posit-dev/skills
Created
9 months ago
Last Updated
3 days ago
Language
R
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category