Documentation and ADRs

Acerca de este Skill

Record architecture decisions, API contracts and project guidance with their context, alternatives and trade-offs. Capture the decision context and alternatives, update documentation where it is used and check prose against actual behavior.

Por qué lo elegimos

A task workflow in Addy's Agent Skills. Follow the upstream instructions and retain referenced shared files; host capabilities and project configuration determine which steps can run.

Para qué sirve

• Future contributors need to understand why a design was chosen.

Workflow and deliverables

Capture the decision context and alternatives, update documentation where it is used and check prose against actual behavior.

Architecture decision records, API documentation or updated project guidance that preserves source details and caveats.

Documentation and ADRs instructions

Install with the required references

Install the complete pack through a documented repository integration when shared references are needed. A per-skill skills CLI install copies only skills/<name>/ and can omit the repository-level references/ checklists; keep the needed shared files with the workflow.

Upstream overview and integrations

Antes de usarlo

• An Agent that can load Skill Markdown and access your project. File edits, shell commands, builds and checks depend on the selected workflow and its environment.
• Use your project's own runtimes, dependencies and verification commands. The Skill files provide instructions and do not install those project tools.
• Install the complete pack through a documented repository integration when shared references are needed. A per-skill skills CLI install copies only skills/<name>/ and can omit the repository-level references/ checklists; keep the needed shared files with the workflow.

Agentes compatibles