View on GitHub

madr

Markdown Architectural Decision Records

Do not emphasize line headings

Context and Problem Statement

MADR contains lines such as Chosen option: "[option 1]". Should “Chosen option” be emphasised?

Decision Drivers

Considered Options

Decision Outcome

Chosen option: “Do not emphasize line headings”, because 1) these headings always are put at the beginning of a line and followed by a colon. Thus, they are already easy to identified as line heading. 2) Readers not familiar with markdown might be confused by stars in the text.