Skip to content

Commit

Permalink
Fixed heading level, made Y template consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
socadk committed Oct 30, 2024
1 parent 617dcbd commit e307bf8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions _posts/2024-10-25-adr-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ MADR is about architectural decisions that *matter* ([`[ˈmæɾɚ]`](https://en.

We think that the *considered options* with their pros and cons are crucial to understand the reasons for choosing a particular design. Therefore, the [Markdown Architectural Decision Records (MADR)](https://adr.github.io/madr/) project in this organization includes such tradeoff analysis information. It also suggests metadata such as decision makers and confirmation in addition to decision status.

## Nygard ADR
### Nygard ADR

An ADR consists of title, status, context, decision, and consequences according to "Documenting Architecture Decisions" by [@mtnygard](https://github.com/mtnygard). <!-- From the Nygard post: "Context This section describes the forces at play, including technological, political, social, and project local." and "We should use a lightweight text formatting language like Markdown or Textile." -->

Check failure on line 31 in _posts/2024-10-25-adr-templates.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

_posts/2024-10-25-adr-templates.md:31:397 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md

Expand All @@ -40,9 +40,9 @@ In short, the Y-statement is as follows:
The long form of it is as follows (extra section "because"):

> In the context of `<use case/user story u>`,
> facing `<concern c>`
> we decided for `<option o>`
> In the context of `<use case/user story>`,
> facing `<concern>`,
> we decided for `<option>`
> and neglected `<other options>`,
> to achieve `<system qualities/desired consequences>`,
> accepting `<downside/undesired consequences>`,
Expand Down

0 comments on commit e307bf8

Please sign in to comment.