Nygard ADR template

Michael Nygard’s 2011 article “Documenting Architecture Decisions” introduced the ADR as a short text file with five parts: a numbered title, a status, the context, the decision stated in active voice (“We will…”), and the consequences, good and bad.

Decisions

    Files are named like 0001-title.md for a docs/adr folder.

     

    Saved you some time? Leave a tip, entirely optional.

    ADRKit writes records in exactly that shape. Type the decision as an action and the tool phrases it as “We will …”, lists consequences as bullets, and adds supersede links under the status.

    How the records fit together

    Each record gets the next free number and a file name made from that number and its title, such as 0002-use-postgresql-as-the-primary-database.md. Numbers never change, even if you delete a record, because other documents may refer to them. When a new decision replaces an old one, choose the old record under Supersedes: the new file gets a “Supersedes” link, the old one is marked Superseded and gets a “Superseded by” link back, and the index shows the change.

    Download all builds a zip with a docs/adr folder containing every record and a README.md index table with number, title, status and date. Unzip it at the root of your repository and commit it, or copy just the index if you keep records elsewhere.

    Choosing a template

    Use MADR when you want to show the options and trade-offs; it is the most complete format and suits decisions that will be debated. Use Nygard for short, quick records where the decision is clear. Use a Y-statement to capture small decisions in one sentence or to summarise a long one. You can change the template of any record at any time; the fields carry across and the preview updates.

    Private by design

    ADRKit has no accounts and no server-side storage. Your records are saved in local storage in this browser only, and the zip is built on your device.

    Frequently asked questions

    How long should a Nygard ADR be?

    One or two pages at most. If it is longer, the decision may need splitting into several records.

    What is the first ADR usually about?

    Many teams start with “Record architecture decisions”, which explains that the project uses ADRs. The examples include it.

    Does it work with adr-tools?

    The file names and headings follow the same conventions, so files drop into an adr-tools docs/adr folder.

    Is ADRKit free?

    Yes. The ADR generator, templates and zip export are free with no account.

    Where are my ADRs stored?

    Only in this browser on this device. Download the zip to keep them in your repository.

    More tools