Download Latest Version 4.0.0 source code.zip (84.7 kB)
Email in envelope

Get an email when there's a new version of Markdown Any Decision Records

Home / 3.0.0-beta
Name Modified Size InfoDownloads / Week
Parent folder
3.0.0-beta.tar.gz 2022-05-17 51.6 kB
3.0.0-beta.zip 2022-05-17 63.6 kB
README.md 2022-05-17 2.2 kB
Totals: 3 Items   117.4 kB 0

Added

  • Added YAML front matter to docs/decisions/adr-template.md
  • Added "Neutral" arguments (in addition to "Good, because", and "Bad, because")
  • Refined howto texts
  • Disable markdown-lint's MD013 - line length for the ADR files.
  • Added initial markdownlint configuration file .markdownlint. This can, for instance, be used by a GitHub linting workflow

Changed

  • Rename "Markdown Architectural Decision Record" to "Markdown Any Decision Record"
  • Place holders for values are denoted by curly braces ({placehodler}). Before it was [placeholder]. #35
  • Directory of ADRs changed from docs/adr to docs/decisions. #33
  • Renamed template.md to adr-template.md. #36
  • Changed ## Links to ## More information
  • Relaxed content of More information section from a bullet list to free text.
  • Changed optional to This is an optional element. Feel free to remove. to make it more clear how to work with an optional element.
  • Changed driver 1 to decicion driver 1.
  • Changed e.g., compromising quality attribute, follow-up decisions required, … to e.g., compromising one or more desired qualities, …
  • Moved the fields to the YAML front matter
  • Renamed template/index.md to template/README.md, because i) README.md is directly rendered on GitHub and ii) for Jekyll-based rendering, the index file has to be adapted (e.g., to show a hint to the doc as MADR does in docs/decisions/index.md).
  • Replace {option 1} place holder to {title of option 1}.
  • Restructured and streamlined documentation.

Removed

  • Removed Technical Story: {description | ticket/issue URL} <!-- optional -->, because all description should go into "Context and Problem Statement"
  • Removed files .adr-dir and .adr-type as tooling should automatically detect the style of the template
Source: README.md, updated 2022-05-17