Update to MADR 4.0.0 (#12016)

* fix typos and update to MADR 4.0.0

* update to MADR 4.0.0

* improve readability

* remove redundant escape characters

docs/decisions/0000-use-markdown-any-decision-records.md → docs/decisions/0000-use-markdown-architectural-decision-records.md

@@ -2,27 +2,28 @@
 parent: Decision Records
 nav_order: 0
 ---
-# Use Markdown Any Decision Records
+# Use Markdown Architectural Decision Records
 
 ## Context and Problem Statement
 
-We want to record any decisions made in this project independent whether decisions concern the architecture ("architectural decision record"), the code, or other fields.
+We want to record architectural decisions made in this project independent whether decisions concern the architecture ("architectural decision record"), the code, or other fields.
 Which format and structure should these records follow?
 
 ## Considered Options
 
+* [MADR](https://adr.github.io/madr/) 4.0.0 – The Markdown Architectural Decision Records
 * [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR"
 * [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
 * Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>
 * Formless – No conventions for file format and structure
 
 ## Decision Outcome
 
-Chosen option: "MADR", because
+Chosen option: "MADR 4.0.0", because
 
 * Implicit assumptions should be made explicit.
   Design documentation is important to enable people understanding the decisions later on.
-  See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940).
+  See also ["A rational design process: How and why to fake it"](https://doi.org/10.1109/TSE.1986.6312940).
 * MADR allows for structured capturing of any decision.
 * The MADR format is lean and fits our development style.
 * The MADR structure is comprehensible and facilitates usage & maintenance.

docs/decisions/0006-only-translated-strings-in-language-file.md

@@ -22,7 +22,7 @@ JabRef has translation files `JabRef_it.properties`, ... There are translated an
 
 ## Decision Outcome
 
-Chosen option: "Only translated strings in language file", because comes out best \(see below.
+Chosen option: "Only translated strings in language file", because comes out best (see below).
 
 ## Pros and Cons of the Options
 

docs/decisions/0007-human-readable-changelog.md

@@ -6,7 +6,7 @@ nav_order: 7
 
 ## Context and Problem Statement
 
-Changes of a release have to be communicated. How and which stile to use?
+Changes of a release have to be communicated. How and which style to use?
 
 ## Considered Options
 

docs/decisions/0019-implement-special-fields-as-separate-fields.md

@@ -17,7 +17,7 @@ How to implement special fields in BibTeX databases?
 
 ## Decision Outcome
 
-Chosen option: "Special fields as separate fields", because comes out best (see below)
+Chosen option: "Special fields as separate fields", because comes out best (see below).
 
 ## Pros and Cons of the Options
 

docs/decisions/0020-use-Jackson-to-parse-study-yml.md

@@ -20,7 +20,7 @@ What parser should be used to parse YAML files?
 
 ## Decision Outcome
 
-Chosen option: Jackson, because as it is a dedicated library for parsing YAML. `yamlbeans` also seem to be viable. They all offer similar functionality.
+Chosen option: "Jackson", because as it is a dedicated library for parsing YAML. `yamlbeans` also seem to be viable. They all offer similar functionality.
 
 ## Pros and Cons of the Options
 

docs/decisions/0036-use-textarea-for-chat-content.md

@@ -25,7 +25,7 @@ This decision record concerns the UI component that is used for rendering the co
 
 ## Decision Outcome
 
-Chosen option: "Use TextArea".
+Chosen option: "Use `TextArea`".
 All other options require more time to implement.
 Some of the options do not support text selection and copying,
 which for now we value more than Markdown rendering.

docs/decisions/adr-template.md

@@ -9,16 +9,16 @@ nav_order: 100
 # Keep this
 parent: Decision Records
 
-# These are optional elements. Feel free to remove any of them.
-# status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)}
-# date: {YYYY-MM-DD when the decision was last updated}
-# deciders: {list everyone involved in the decision}
-# consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
-# informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
+# These are optional metadata elements. Feel free to remove any of them.
+status: "{proposed | rejected | accepted | deprecated | … | superseded by ADR-0123"
+date: {YYYY-MM-DD when the decision was last updated}
+decision-makers: {list everyone involved in the decision}
+consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
+informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
 ---
 <!-- we need to disable MD025, because we use the different heading "ADR Template" in the homepage (see above) than it is foreseen in the template -->
 <!-- markdownlint-disable-next-line MD025 -->
-# {short title of solved problem and solution}
+# {short title, representative of solved problem and found solution}
 
 ## Context and Problem Statement
 
@@ -41,25 +41,19 @@ parent: Decision Records
 
 ## Decision Outcome
 
-Chosen option: "{title of option 1}", because
-{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
 
 <!-- This is an optional element. Feel free to remove. -->
-### Positive Consequences
+### Consequences
 
-* {e.g., improvement of one or more desired qualities, …}
-* …
-
-<!-- This is an optional element. Feel free to remove. -->
-### Negative Consequences
-
-* {e.g., compromising one or more desired qualities, …}
-* …
+* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
+* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
+* … <!-- numbers of consequences can vary -->
 
 <!-- This is an optional element. Feel free to remove. -->
-## Validation
+### Confirmation
 
-{describe how the implementation of/compliance with the ADR is validated. E.g., by a review or an ArchUnit test}
+{Describe how the implementation of/compliance with the ADR can/will be confirmed. Is the chosen design and its implementation in line with the decision? E.g., a design/code review or a test with a library such as ArchUnit can help validate this. Note that although we classify this element as optional, it is included in many ADRs.}
 
 <!-- This is an optional element. Feel free to remove. -->
 ## Pros and Cons of the Options
@@ -89,8 +83,4 @@ Chosen option: "{title of option 1}", because
 <!-- This is an optional element. Feel free to remove. -->
 ## More Information
 
-{You might want to provide additional evidence/confidence for the decision outcome here and/or
- document the team agreement on the decision and/or
- define when this decision when and how the decision should be realized and if/when it should be re-visited and/or
- how the decision is validated.
- Links to other decisions and resources might here appear as well.}
+{You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement on the decision and/or define when/how this decision the decision should be realized and if/when it should be re-visited. Links to other decisions and resources might appear here as well.}

docs/decisions/index.md

@@ -4,7 +4,7 @@ has_children: true
 ---
 # Decision Records
 
-Below, all "any decision records" for JabRef are listed.
+Below, all "architectural decision records" for JabRef are listed.
 This list uses the TOC functionality of the [Just the Docs Jekyll template](https://just-the-docs.github.io/just-the-docs/).
 
 For new ADRs, please use [adr-template.md](adr-template.md) as basis.