sky-uk / csp-tech-radar

The Sky Plc Content Supply Platforms department technology radar.
Creative Commons Attribution Share Alike 4.0 International
6 stars 4 forks source link

add lighweight decision records to adopt in techniques #14

Closed pburls closed 6 years ago

pburls commented 6 years ago

Much documentation can be replaced with highly readable code and tests. In a world of evolutionary architecture, however, it's important to record certain design decisions for the benefit of future team members as well as for external oversight. Lightweight Architecture Decision Records is a technique for capturing important architectural decisions along with their context and consequences. We recommend storing these details in source control, instead of a wiki or website, as then they can provide a record that remains in sync with the code itself. For most projects, we see no reason why you wouldn't want to use this technique.