Skill: Technical Documentation

To write AI-navigable technical documentation, you need to structure outputs with clear file descriptions, glossary additions, and ADR summaries. This approach ensures coding agents can reliably parse the docs and take action based on shared domain language.

Maintaining terminological consistency requires using a shared domain glossary stored in a CONTEXT.md file. By enforcing consistent terminology during documentation updates, teams ensure that new and changing systems remain aligned and clearly understood.

Enforcing ADR discipline involves capturing hard-to-reverse architectural choices as Architecture Decision Records during development. You should prioritize documenting the 'why' over the 'what' to maintain concision and provide a durable ADR summary for future reference.

You need to create Architecture Decision Records whenever making hard-to-reverse choices during new system development or onboarding. ADRs capture the context of these architectural decisions, ensuring durable documentation that explains why specific choices were made.

Yes, you can audit existing technical docs to align terminology and update your CONTEXT.md domain glossary. The process produces consistent outputs describing updated files and glossary additions, turning scattered knowledge into AI-navigable documentation.

Prioritizing concision in architecture decision records means documenting only what is necessary for understanding and maintainability, focusing strictly on the 'why'. This guardrail limits excessive detail, ensuring the documentation remains durable without capturing unnecessary implementation specifics.