ADRKit

Y-statement ADR generator

The Y-statement packs a whole decision into one structured sentence: in the context of a use case, facing a concern, we decided for an option and neglected the alternatives, to achieve a quality, accepting a downside, because of a rationale. It is ideal for lightweight records or for summarising a longer ADR.

Decisions

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

     
     
     
      
    Saved you some time? Leave a tip, entirely optional.
      
     
    Fill in each part in ADRKit and it assembles the sentence with the right connecting words, leaving out the chosen option from the neglected list automatically.
     
    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
     
    Where does the Y-statement come from?
    It was proposed by Olaf Zimmermann and colleagues as a compact way to capture design decisions; the name comes from the shape of its two halves.
    Can I list several concerns?
    Yes. Put one per line and they are joined with “and”.
    Is the “because” part required?
    No. It is optional and only added when you fill it in.
    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