describe-design

Solid

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 379 stars 32 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
86
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
6 months ago
Last Updated
3 days ago
Language
R
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

architect-system

Designs technical blueprints — tech stack selection, database schema, API design, file structure, and deployment plan for a defined product or feature. Produces `architecture/system-architecture.md`. Not for unclear requirements (use discover) or task decomposition (use breakdown-tasks). For user journey mapping, see map-user-flow. For code quality after building, see review-work.

10 Updated today
hungv47
Code & Development Listed

design-doc

Use this skill before writing any non-trivial code, especially when starting a new feature, service, or codebase. It produces a structural design document that commits to module boundaries, contracts, and data shapes BEFORE implementation begins. Trigger this whenever the user describes building something new, asks to "build", "create", or "implement" a system or feature larger than a single function, or whenever the conversation is about to move from discussion into code. Also trigger if the user mentions architecture, system design, planning, or wanting to "think through" a build before coding. Especially important for AI-generated codebases where unconstrained generation tends to sprawl into accidental complexity.

5 Updated today
taniwhaai
Code & Development Listed

architecture

Design system architecture with trade-offs. Keywords: architecture, design, database, API, frontend, backend, security, scaling, decisions, tech stack, patterns

2 Updated today
jvalin17
Data & Documents Solid

codebase-documenter

Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.

593 Updated 2 months ago
mhattingpete
Web & Frontend Solid

nw-design

Designs system architecture with C4 diagrams and technology selection. Routes to the right architect based on design scope (system, domain, application, or full stack). Two interaction modes: guide (collaborative Q&A) or propose (architect presents options with trade-offs).

526 Updated 1 weeks ago
nWave-ai