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.
Installation
There are a number of ways to install skills. We made {ally}, an R package that simplifies the process. Learn more
Install {pak}:
install.packages("pak")
Then install {ally}:
pak::pak("rfortherestofus/ally")
You only need to do this once per computer.
After you've installed the {ally} package, choose whether you want to install the skill in this project or in all of your projects, then run the command.
ally::install_skill("https://github.com/posit-dev/skills/blob/main/posit-dev/describe-design/SKILL.md")
This puts the skill in locations that all agents can read, inside this project, so anyone you're working with on the project can use it.
ally::install_skill("https://github.com/posit-dev/skills/blob/main/posit-dev/describe-design/SKILL.md", scope = "user")
This puts the skill in locations that all agents can read, in your home folder, so every project you work on can use it.
