Architectural Decision Records

Architectural decisions are made throughout a project’s lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below.

• 1. Record architecture decisions
• 2. Adopt python-copier-template for project structure
• 3. Play the book in the page, not in Audiobookshelf
• 4. Choose a place from a list, rather than talk about it
• 5. Render one book at a time, in its own unit, and let the page watch
• 6. Answer a question about the book, out of what you know, as far as they have listened
• 7. Cross a chapter without letting go of the player
• 8. A second library, under the same ids
• 9. Drop Audiobookshelf
• 10. Draw the spoiler line where they are
• 11. Put the guard on the row, not on the search
• 12. One way a goto ends

A record here is usually amended in place rather than superseded by a later one, so read the Status section first: it says whether anything below it has been withdrawn, and points at the amendment or the record that did it. Records 3, 4 and 5 all carry amendments, and record 3 carries a retraction — a claim it made about the handset that turned out to have been checked only one way. The retraction is kept beside the claim on purpose. A decision record that quietly loses its mistakes is a record of what we would like to have decided.

Records 10, 11 and 12 all amend 4 and 6, and none disturbs a conclusion: 10 takes away the high-water mark both argue partly from, 11 takes the spoiler bound off the search and puts it on what may be said of each result, and 12 takes away the model’s choice between moving the book and drawing the list.

Record 9 is the exception that makes the rule worth stating. Dropping Audiobookshelf could have been done by editing it out of records 3 and 7, and that would have left record 3 arguing at length against a thing it never mentions. So it is its own record, and 3 and 7 say at the top of themselves which of their clauses it takes away.

For more information on ADRs see this blog by Michael Nygard.