DevOps Generators

ADR / RFC Builder

All tools

Write down an architecture decision in a consistent format while the reasoning is still fresh.

How it works

Four simple steps

1

Set the title

Name the decision in a few words.

2

Pick format and status

Choose ADR or RFC, then Proposed, Accepted, Deprecated or Superseded.

3

Write context and decision

Explain the problem and what you chose.

4

Export the Markdown

Copy or download, then fill in the remaining sections.

ADR / RFC Builder

About ADR / RFC Builder

Six months after the team chose a message queue, nobody remembers why the other option lost. A short decision record written at the time would answer that, and this builder supplies the structure so writing one takes minutes.

Type a title, pick ADR (MADR) or Lightweight RFC, set the status (Proposed, Accepted, Deprecated or Superseded) and the date, which defaults to today. Add the context and the decision in the two text boxes. The ADR format places them under Context and Problem Statement and Decision Outcome, with placeholder sections for deciders, decision drivers, considered options and consequences. The RFC format uses your decision as the Summary and your context as the Motivation, then leaves Detailed design, Alternatives considered and Unresolved questions to fill in.

The placeholders are generic (Option A, Option B and two sample drivers), so replace them before review. The most useful part of an ADR is usually the options you rejected and why. Number the records (0007-adopt-openapi.md) and keep them in the repository next to the code so they are reviewed in pull requests like anything else. When a decision is replaced, mark the old record Superseded instead of deleting it.

The text is assembled in the page and saved as decision.md. Render it in the Markdown previewer before sharing, and for option comparisons inside a record, the Markdown table generator helps.

Keyboard shortcut

Ctrl Enter - Run tool
FAQ

Frequently asked questions

See all FAQs

Answers for this tool. For site-wide help, open the FAQ hub.

An ADR records a decision that has been made or is close to final, with its context and consequences. An RFC proposes a change and gathers feedback before anything is decided. Many teams write an RFC first and capture the outcome as an ADR.

Markdown Architectural Decision Records, an open template for ADRs written in Markdown. The ADR output here follows its section names in a shortened form.

No. It defaults to today, but you can pick any date, which helps when writing up a decision that was made earlier.

View more FAQs

Related tools

View all

Kubernetes Manifest Studio

Generate Deployment, Service, and Ingress YAML with a drift checklist.

Open

K8s Inspector

Summarize Kubernetes YAML kinds, names, and labels.

Open

K8s Resource Diff

Diff two Kubernetes manifests locally.

Open

K8s Manifest Splitter

Split multi-document YAML into one file per resource.

Open

Explore 321 free tools

Everything you need as a developer, marketer or creator - in one beautiful place.

Browse all tools