3 ms·
It didnt even touch the main points, imho. 1. You have to maintain both documentation and code. If you change code and forget to update documentation it can be
by randomNumber7 1y ago
It didnt even touch the main points, imho.
1. You have to maintain both documentation and code. If you change code and forget to update documentation it can be very confusing and cost a lot of time.
2. Proper code should explain itself (to some extend).
3. Taking a lot of time to write proper documentation is rarely appreciated in a world where long term strategic thinking has no place anymore.
4. It's harder to fire you if you when you are the only guy who knows all the stuff.
- dcminter 1y agoWith respect to (1) I'd love to see more tooling like Rust's documentation tests where broken examples in the doocumentation can fail the build; it can't force the lazy to make good docs but it can make the well intentioned aware of drift between the documentation and the code.
- MOARDONGZPLZ 1y agoTo be fair, the AI that wrote it has no hands on experience with documentation, so it’s natural that it would miss some of these practical points.