Merge pull request #2048 from Agoric/mfig/adr-1

Use architecture decision records

docs/architecture/0001-record-architecture-decisions.md

@@ -0,0 +1,80 @@
+# ADR 1: Record architecture decisions
+
+*Taken almost verbatim from [Michael Nygard's article on the
+subject](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)*
+
+## Status
+
+2020-11-23 - Proposed
+
+## Context
+
+Architecture for agile projects has to be described and defined differently. Not all decisions will be made at once, nor will all of them be done when the project begins.
+
+Agile methods are not opposed to documentation, only to valueless documentation. Documents that assist the team itself can have value, but only if they are kept up to date. Large documents are never kept up to date. Small, modular documents have at least a chance at being updated.
+
+Nobody ever reads large documents, either. Most developers have been on at least one project where the specification document was larger (in bytes) than the total source code size. Those documents are too large to open, read, or update. Bite sized pieces are easier for for all stakeholders to consume.
+
+One of the hardest things to track during the life of a project is the motivation behind certain decisions. A new person coming on to a project may be perplexed, baffled, delighted, or infuriated by some past decision. Without understanding the rationale or consequences, this person has only two choices:
+
+1. Blindly accept the decision.
+
+This response may be OK, if the decision is still valid. It may not be good, however, if the context has changed and the decision should really be revisited. If the project accumulates too many decisions accepted without understanding, then the development team becomes afraid to change anything and the project collapses under its own weight.
+
+2. Blindly change it.
+
+Again, this may be OK if the decision needs to be reversed. On the other hand, changing the decision without understanding its motivation or consequences could mean damaging the project's overall value without realizing it. (E.g., the decision supported a non-functional requirement that hasn't been tested yet.)
+
+It's better to avoid either blind acceptance or blind reversal.
+
+## Decision
+
+We will keep a collection of records for "architecturally significant" decisions: those that affect the structure, non-functional characteristics, dependencies, interfaces, or construction techniques.
+
+An architecture decision record is a short text file in a format similar to an Alexandrian pattern. (Though the decisions themselves are not necessarily patterns, they share the characteristic balancing of forces.) Each record describes a set of forces and a single decision in response to those forces. Note that the decision is the central piece here, so specific forces may appear in multiple ADRs.
+
+We will keep ADRs in the project repository under doc/arch/adr-NNN.md
+
+We should use a lightweight text formatting language like Markdown or Textile.
+
+ADRs will be numbered sequentially and monotonically. Numbers will not be reused.
+
+If a decision is reversed, we will keep the old one around, but mark it as superseded. (It's still relevant to know that it was the decision, but is no longer the decision.)
+
+We will use a format with just a few parts, so each document is easy to digest. The format has just a few parts.
+
+**Title** These documents have names that are short noun phrases. For example, "ADR 1: Deployment on Ruby on Rails 3.0.10" or "ADR 9: LDAP for Multitenant Integration"
+
+**Status**   We will start with a date (in [ISO 8601 extended
+format](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates)) of when the
+status changed, but other metadata will only be captured in the source
+repository history.  A decision may be "proposed" if the project stakeholders
+haven't agreed with it yet, or "accepted" once it is agreed. If a later ADR
+changes or reverses a decision, it may be marked as "deprecated" or "superseded"
+with a reference to its replacement.
+
+**Context** Note the project to which this ADR applies, including other
+relevant ADRs.  This section describes the forces at play, including
+technological, political, social, and project local. These forces are probably
+in tension, and should be called out as such. The language in this section is
+value-neutral. It is simply describing facts.
+
+**Decision** This section describes our response to these forces. It is stated in full sentences, with active voice. "We will …"
+
+**Consequences** This section describes the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.
+
+The whole document should be one or two pages long. We will write each ADR as if it is a conversation with a future developer. This requires good writing style, with full sentences organized into paragraphs. Bullets are acceptable only for visual style, not as an excuse for writing sentence fragments. (Bullets kill people, even PowerPoint bullets.)
+
+## Consequences
+
+One ADR describes one significant decision for a specific project. It should be something that has an effect on how the rest of the project will run.
+
+The consequences of one ADR are very likely to become the context for subsequent ADRs. This is also similar to Alexander's idea of a pattern language: the large-scale responses create spaces for the smaller scale to fit into.
+
+Developers and project stakeholders can see the ADRs, even as the team composition changes over time.
+
+The motivation behind previous decisions is visible for everyone, present and future. Nobody is left scratching their heads to understand, "What were they thinking?" and the time to change old decisions will be clear from changes in the project's context.
+
+Every requirement of the ADR format comes at the cost of more friction, so
+starting with a simple structure is prudent.  Refinements can be added in future
+ADRs as agreed on by the team.

docs/architecture/adr-template.md

@@ -0,0 +1,25 @@
+# ADR [Number]: [Title]
+
+> *This template is derived from [ADR#1](./0001-record-architecture-decisions.md)*
+
+> These documents have names that are short noun phrases. For example, "ADR 1: Deployment on Ruby on Rails 3.0.10" or "ADR 9: LDAP for Multitenant Integration"
+
+## Status
+
+> [ISO 8601 Date] - Proposed
+
+## Context
+
+> Note the project to which this ADR applies, including other relevant ADRs.
+> This section describes the forces at play, including technological, political,
+social, and project local. These forces are probably in tension, and should be
+called out as such. The language in this section is value-neutral. It is simply
+describing facts.
+
+## Decision
+
+> This section describes our response to these forces. It is stated in full sentences, with active voice. "We will …"
+
+## Consequences
+
+> This section describes the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.