Skip to content

Commit

Permalink
Improve formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
joelparkerhenderson authored Nov 11, 2017
1 parent 8ad51b1 commit a960f93
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,32 @@ To start using ADRs, talk with your teammates about these areas.

1. Decision identification

* How urgent and how important is the AD?
* Does it have to be made now, or can it wait until more is known?
* Both personal and collective experience, as well as recognized design methods and practices, can assist with decision identification.
* Ideally maintain a decision todo list that complements the product todo list.
* How urgent and how important is the AD?
* Does it have to be made now, or can it wait until more is known?
* Both personal and collective experience, as well as recognized design methods and practices, can assist with decision identification.
* Ideally maintain a decision todo list that complements the product todo list.

2. Decision making

* A number of decision making technqiues exists, both general ones and software and software architecture specific ones, for instance, dialogue mapping. Group decision making is an active research topic.
* A number of decision making technqiues exists, both general ones and software and software architecture specific ones, for instance, dialogue mapping.
* Group decision making is an active research topic.

3. Decision documentation

* Many templates and tools for decisison capturing exist, both in agile communities (e.g., M. Nygard's ADRs) and in traditional software engineering and architecture design processes (e.g., see table layouts suggested by IBM UMF and by Tyree and Akerman from CapitalOne.
* Many templates and tools for decisison capturing exist.
* See agile communities, e.g. M. Nygard's ADRs.
* See traditional software engineering and architecture design processes, e.g. table layouts suggested by IBM UMF and by Tyree and Akerman from CapitalOne.

4. Decision enactment and enforcement

* ADs are used in software design; hence they have to be communicated to, and accepted by, the stakeholders of the system that fund, deveop, and operate it. Architecturally evident coding styles and code reviews that focus on architectural concerns and decisions are two related practices. ADs also have to be (re-)considered when modernizing a software sytem in software evolution.
* ADs are used in software design; hence they have to be communicated to, and accepted by, the stakeholders of the system that fund, deveop, and operate it.
* Architecturally evident coding styles and code reviews that focus on architectural concerns and decisions are two related practices.
* ADs also have to be (re-)considered when modernizing a software sytem in software evolution.

5. Decision sharing (optional)

* Many ADs recur across projects; hence, experiences with past decisions, both good and bad, can be valuable reusable assets when employing an explicit knowledge management strategy.
* Many ADs recur across projects.
* Hence, experiences with past decisions, both good and bad, can be valuable reusable assets when employing an explicit knowledge management strategy.


<h2><a name="how-to-start-using-adrs-with-tools">How to start using ADRs with tools</a></h2>
Expand Down Expand Up @@ -108,16 +114,14 @@ Examples:

Our file name convention:

* The name has the date as YYYY-MM-DD. This arrangement is ISO standard, and is useful for easily sorting by date.
* The name has the date as YYYY-MM-DD. This is ISO standard and helps for sorting by date.

* The name has a present tense imperative verb phrase. This is helpful for readability and matches our commit message format.
* The name has a present tense imperative verb phrase. This helps readability and matches our commit message format.

* The name uses sentence capitalization and spaces. This is helpful for readability.

* The extension is markdown. This can be useful for easy formatting.

Note about the date format: we like the format YYYY

<h2><a name="contributing">Contributing</a></h2>

Your comments and suggestions are welcome.
Expand Down

0 comments on commit a960f93

Please sign in to comment.