An Architecture Decision Record (ADR) is a document that captures important decisions made during the design and development of a software system. These decisions can range from high-level architectural choices to more detailed technical decisions. ADRs are a valuable tool for teams because they help to document and communicate decisions, provide a record of the …
Category Archives: documentation
Readme rules
Here are the top 5 rules for all repository readme’s 1. Tell me what the repository is for in plain English. Even better, give me a diagram on what it does and how it does it. I’m talking a paragraph, maybe two, three at the most with an overview of what the repository (…application, package, …