Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 938 Bytes

File metadata and controls

31 lines (22 loc) · 938 Bytes

Architecture Decision Records (ADRs)

ADRs are a recommended documentation method for our projects – besides keeping the README up-to-date and documenting all the not obvious code inline.

When to write ADRs

If the project is expected to be maintained and not thrown away it is a great idea to document important decisions.

When project uses new architecture, dependencies or new technologies there is no doubt ADRs are a great solution to improve the sustainability and handover of the project.

They should improve our team knowledge all over our projects. They make decisions transparent for developers who will be exploring and working with the repository in the future.

What to document using ADRs

  • Dependencies
  • Architecture
  • Tools
  • Preferred technologies
  • Helpers

Resources