3 ms·
I think this falls into a common mistake people make about documentation. Good documentation doesn't explain what the code does, it explains why the code is wri
by 8organicbits 3y ago
I think this falls into a common mistake people make about documentation. Good documentation doesn't explain what the code does, it explains why the code is written the way it is, the constraints that caused this decision to be made and even alternatives not considered. You cant really guess those things by looking a code. I'm a fan of ADRs for that reason.
Honestly this looks overly verbose to me, a common LLM problem. The mistakes others cite, are also pretty concerning.
https://adr.github.io/ https://adr.github.io/
- _a_a_a_ 3y agoGood point, completely agree and interesting link, thanks