View on GitHub

madr

Markdown Architectural Decision Records

Use curly brackets to denote placeholders

Context and Problem Statement

When crafting an ADR placeholders need to be replaced by real values. How to mark the place holders?

Considered Options

Decision Outcome

Chosen option: “Use curly braces”, because comes out best (see below).

Pros and Cons of the Options

Use curly braces

Example: {option 1}.

Use square brackets

Example: [option 1].

Use less-than and greater-than

Example: <option 1>

Idea taken from https://github.com/schubmat/DecisionCapture/blob/master/templates/captureTemplate_full.md