ADRs

[KyleKing]

Initialize an ADR format and start using them

• Cool log4brains tool to generate websites for ADRs with a timeline and they host their own ADRs
• AWS
• Y-Statements: abbreviated shorthand. Add this as a one-line decision option if a full ADR isn't needed (or when referencing an existing ADR)
• Look at more formal implementation of ADRs (MADR) that this is based on
  • Use the Markdown Style Guide space-sentence:1, wrap:sentence, header:atx, list-marker:asterisk, list-space:1, code:fenced
• MantiD Project
• Can the TOC of ADRs be auto-generated?
• Pull latest template from hosted or fallback to local copy?
• Examples
  • Example: https://github.com/arachne-framework/architecture
  • Example: https://concourse-ci.org/internals.html
  • Example proposal for configuration: https://github.com/arachne-framework/architecture/blob/master/adr-002-configuration.md
  • https://boltons.readthedocs.io/en/latest/architecture.html
  • Architecture mkdocstrings/mkdocstrings#28
  • "PIN" from Prefect
  • "EIPs" from Ethereum
  • Midnighter/structurizr-python
  • (How was the diagram made?) Packet Cafe
• PEPs such as the discussion for "statistics"
• TImescaleDB Design
• Review non-functional requirements for quick reference in justifying ADR decisions: https://www.boxuk.com/insight/guide-to-non-functional-requirements-types-and-examples/
• Review common SW Architecture patterns: https://priyalwalpita.medium.com/software-architecture-patterns-which-one-to-choose-1e368b43fe70
  • Review other SW Arch resources: https://mehdihadeli.github.io/awesome-software-architecture/
  • See example projects: https://reddit.com/r/learnpython/comments/n5a6fo/do_you_know_any_python_projects_on_github_that/