describe-design
Research a codebase and create architectural documentation describing how features or systems work.
Source: posit-dev
At a glance
- Best for
- Writing & Content
- Works with
- Claude Code
- Outcome
- Research a codebase and create architectural documentation describing how features or systems work.
- Source
- posit-dev/skills
01 / Understand the skill
About describe-design
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.
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.
Read full description
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.
Check before installing
Compatible platforms
Claude Code
Best fit
Writing & Content
Review the source instructions if the required output differs from the formats described above.
Install and use
Compatible with Claude Code · Published by posit-dev
Ready to add describe-design?
Use the published instructions below, then provide the required input and describe the result you need.
General instructions · Claude Code
npx -y skills add posit-dev/skills --skill describe-design --agent claude-code
Review the source repository and license before installing third-party skills.
Continue exploring
Similar skills
Write internal communications — status reports, 3P updates, leadership notes, newsletters, FAQs, incident reports — in your company's formats.
Reviews docs and prose against Vercel's Writing Guidelines by fetching the latest rules and reporting findings in a terse file:line format.
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides.
Generate beautiful CHANGELOG.md from git commits following Keep a Changelog format