3 ms·
Until the requirements change 12 times over 12 months, and that time invested writing prose with all the stuff that goes with it goes down the drain. Don't get
by keyle 4y ago
Until the requirements change 12 times over 12 months, and that time invested writing prose with all the stuff that goes with it goes down the drain.
Don't get me wrong, I'm not saying commit crap. I'm saying "Yes But". Use code as documentation, use Tests as defence turrets, forget the poetic muppetry. The code should reflect the now and mark the pitfalls. If the code is well written, I should be able to understand the why it's done this way. Don't send me off to some document on confluence written by the dude that left 2 years ago.
- simonw 4y agoThat is the exact argument I'm making this article: if your documentation is on confluence it will inevitably go out of date. The solution to that is to keep the documentation in the same repository of the code, and update it in lock step every time you make an implementation change that affects the documentation.