ADR examples

The quickest way to learn the format is to read a few records. This page loads three examples into ADRKit: “Record architecture decisions” in Nygard format, “Use PostgreSQL as the primary database” in MADR, and “Deploy as a modular monolith” as a Y-statement.

Decisions

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

     

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

    Click any record in the list to see its Markdown, then change the details to fit your project, or press New ADR to start your own with the next number.

    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

    What makes a good ADR?

    A specific title that states the decision, enough context for a newcomer, the alternatives you rejected and honest negative consequences.

    Should rejected options get their own ADR?

    Usually not. List them under considered options. Write an ADR with status Rejected when a proposal itself was turned down.

    How many ADRs does a project have?

    Anything from a handful to a few hundred. Only record decisions that matter architecturally.

    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