madr - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

CHANGELOG.md

@@ -7,4 +7,15 @@ # Changelog
 
-## [Unreleased]
+## [1.3.0] – 2018-01-30
 
+### Changed
+- Changed template to be closer to the [Y-Statements](https://www.infoq.com/articles/sustainable-architectural-design-decisions).
+  Especially rename "alternative" to "option"
+- Restructured syntax of "Decision Outcome".
+  Positive and negative consequences as separate bullet list.
+- More Y-Statement-like -- add "facing"
+- Rename "point" to "argument" (which reverts the change of version 1.2.0)
+- Number "arguments" from a to c. Re-use "variables" a to c to guide the author that the same topic should be handled by the enumeration. e..g, performance, ...
+- Exchange `+` and `-` by "Good, because ..." and "Bad, because ..."
+- Remove emphasize of "User Story:"
+
 ## [1.2.0] – 2018-01-26
@@ -42,3 +53,4 @@
 
-[Unreleased]: https://github.com/adr/madr/compare/1.2.0...master
+[Unreleased]: https://github.com/adr/madr/compare/1.3.0...master
+[1.3.0]: https://github.com/adr/madr/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/adr/madr/compare/1.1.1...1.2.0
@@ -45,0 +57,0 @@ [1.1.1]: https://github.com/adr/madr/compare/1.1.0...1.1.1

package.json

@@ -14,3 +14,3 @@ {
   ],
-  "version": "1.2.0",
+  "version": "1.3.0",
   "homepage": "https://adr.github.io/madr/",
@@ -17,0 +17,0 @@ "author": "Oliver Kopp (http://github.com/koppor/)",

README.md

@@ -43,41 +43,47 @@ # Markdown Architectural Decision Records
 
-**User Story:** [ticket/issue-number] <!-- optional -->
+User Story: [ticket/issue-number] <!-- optional -->
 
 [context and problem statement]
-[decision drivers | forces] <!-- optional -->
+[decision drivers | forces | facing] <!-- optional -->
 
-## Considered Alternatives
+## Considered Options
 
-* [alternative 1]
-* [alternative 2]
-* [alternative 3]
-* ... <!-- numbers of alternatives can vary -->
+* [option 1]
+* [option 2]
+* [option 3]
+* ... <!-- numbers of options can vary -->
 
 ## Decision Outcome
 
-* Chosen Alternative: [alternative 1]
-* [justification. e.g., only alternative, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]
-* [consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...] <!-- optional -->
+Chosen option: [option 1], because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)].
 
-## Pros and Cons of the Alternatives <!-- optional -->
+Positive Consequences: <!-- optional -->
+  - [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...]
+  - ...
 
-### [alternative 1]
+Negative consequences: <!-- optional -->
+  - [e.g., compromising quality attribute, follow-up decisions required, ...]
+  - ...
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+## Pros and Cons of the Options <!-- optional -->
+
+### [option 1]
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->
 
-### [alternative 2]
+### [option 2]
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->
 
-### [alternative 3]
+### [option 3]
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->
@@ -84,0 +90,0 @@ ```

template/template.md

 # [short title of solved problem and solution]
 
-**User Story:** [ticket/issue-number] <!-- optional -->
+User Story: [ticket/issue-number] <!-- optional -->
 
 [context and problem statement]
-[decision drivers | forces] <!-- optional -->
+[decision drivers | forces | facing] <!-- optional -->
 
-## Considered Alternatives
+## Considered Options
 
-* [alternative 1]
-* [alternative 2]
-* [alternative 3]
-* ... <!-- numbers of alternatives can vary -->
+* [option 1]
+* [option 2]
+* [option 3]
+* ... <!-- numbers of options can vary -->
 
 ## Decision Outcome
 
-* Chosen Alternative: [alternative 1]
-* [justification. e.g., only alternative, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]
-* [consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...] <!-- optional -->
+Chosen option: [option 1], because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)].
 
-## Pros and Cons of the Alternatives <!-- optional -->
+Positive Consequences: <!-- optional -->
+  - [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...]
+  - ...
 
-### [alternative 1]
+Negative consequences: <!-- optional -->
+  - [e.g., compromising quality attribute, follow-up decisions required, ...]
+  - ...
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+## Pros and Cons of the Options <!-- optional -->
+
+### [option 1]
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->
 
-### [alternative 2]
+### [option 2]
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->
 
-### [alternative 3]
+### [option 3]
 
-* `+` [pro point]
-* `+` [pro point]
-* `-` [con point]
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
 * ... <!-- numbers of pros and cons can vary -->

No alert changes

Improved metrics

Total package byte prevSize

12563

increased by10.11%

Number of lines in readme file

172

increased by3.61%

No dependency changes