Software Development

Documentation And ADRs

Writes architecture decision records (ADRs) and keeps the rest of a project's documentation true after a change: README, reference comments on public interfaces and the changelog. Use when a user says "write an ADR", "record this decision", "document why we chose X", "set up a decision log", "supersede the old decision", "update the README", "add a changelog entry" or "document this API". Produces records in the Nygard or MADR format, a Keep a Changelog entry, and a script that checks the log for gaps and broken supersession links.

Publisher / source
TerminalSkills Library
Upstream record
TerminalSkills/skills
Version
Version 4
Published
Publication review
Approved for publication
Content fingerprint
11674906568252115a64d75313b8c665dba8cdfbaa619328f04c66a6b3d6733e