DEV Community

Discussion on: Improve documentation quality with Architectural decision records

Collapse
 
downey profile image
Tim Downey

We've dabbled with these on my team. So far so good and should be valuable resources to point to as new folks rotate through.

Hardest part for me at least is just determining when a decision is important enough to record.

Collapse
 
napicella profile image
Nicola Apicella • Edited

Nice!

About deciding if a record should be written or not: my bias is to write more records rather than less.
Our own solutions always seem obvious, thus not worth documenting.
But we are the worst judge of that.

When in doubt I also share it with other teammates or people who might not have all the necessary context.

Ultimately, because the records are versioned controlled, they can be reviewed as part of the Code review process.