View on GitHub

madr

Markdown Architectural Decision Records

Support categories

Context and Problem Statement

ADRs are recorded. The number of ADRs grows and the context/topic/scope of ADRs might be different (e.g., frontend, backend)

Decision Drivers

Considered Options

Decision Outcome

Chosen option: “Use subfolders with local ids”

Pros and Cons of the Options

Use labels

Example:

Use Angular category-frontend

![category-frontend](https://img.shields.io/badge/category-frontend-blue.svg?style=flat-square)

Add * Category: CATEGORY directly under the heading

Use YAML frontmatter

Example:

---
category: frontend
---

Encode category in filename

Example: 0050--frontend--title-with-dashes.md

Use subfolders with local ids

Optionally “to-be-categorized” folder.

One level of subfolder, not nested

Examples

Pros/cons

Use subfolders with global ids

Examples