3 ms·
The points in that post are all valid. Lots of docs are just a waste of letters. Document the intent. Why did you decide to spend the time to write this code.
by wizzard0 3y ago
The points in that post are all valid. Lots of docs are just a waste of letters.
Document the intent.
Why did you decide to spend the time to write this code.
What shortcuts were taken (what code doesn’t do!), and why!
- P_I_Staker 3y agoI've seen a lot of teams ask developers to write duplicate documents. The supplier provides decent docs, and I guess they want you to read the document and tell them what matters for our project. Perhaps it's not that crazy a request, but you will likely have to use the supplier docs anyway. I'm basically being asked to make a worse version of the document the vendor gave me. These are not crazy long documents either.