9 ms·
Did you receive many components bootstrapped by someone else? I’ve picked several projects along the way and just having one or two ADRs helped me so much. Som
by villasv 5y ago
Did you receive many components bootstrapped by someone else?
I’ve picked several projects along the way and just having one or two ADRs helped me so much. Sometimes a piece was not working so well, but without knowing why it was made that way made it really risky to just decide on a change.
Like code comments and any documentation in general, design docs aren’t best for telling what something is/does but why it exists, why alternatives were discarded, why apparently suboptimal behavior was chosen and so on.
- adverbly 5y agoFrom my understanding, that is what architecture.md is for. 1 doc to describe the current state and reasons for it, rather than 1 doc per change.