Documentation and ADRs
Document decisions, not just code. The most valuable documentation captures the why — the context, constraints, and tradeoffs that led to a decision. Code shows what was built; documentation explains why it was built this way and what alternatives were considered.
概览
The Documentation and ADRs skill, part of the TerminalSkills/skills repository, provides AI agents like Claude and Gemini with a framework for capturing architectural decision records (ADRs). Rather than focusing solely on code output, this skill emphasizes the preservation of technical context, including the specific constraints and tradeoffs encountered during development. By documenting the rationale behind design choices, the skill ensures that the "why" of a project is as accessible as the "what." This approach helps maintain long-term project health by recording rejected alternatives and decision-making logic. As a component of the TerminalSkills collection, which has garnered 72 stars on GitHub, this skill facilitates structured data validation and comprehensive documentation workflows across various compatible AI platforms.
使用场景
安装说明
# Review source first
open https://github.com/TerminalSkills/skills/blob/main/skills/documentation-and-adrs/SKILL.mdCopy or clone the skill folder into your agent skills directory after reviewing its instructions and scripts.
安全提示
Users should ensure that any architectural decision records generated do not inadvertently include sensitive credentials or internal infrastructure secrets. Since this skill focuses on documenting the logic and constraints of a project within the TerminalSkills/skills repository, standard data validation practices should be applied to all output to maintain security compliance across compatible agents.