4 ms·
The frustrating thing about poor documentation is that the product actually works! It's just that the creator didn't go the last 5% of the way to explain to som
by darkerside 9y ago
The frustrating thing about poor documentation is that the product actually works! It's just that the creator didn't go the last 5% of the way to explain to someone else how. The close-ness of the solution is what makes it frustrating by nature (it's not frustrating when you encounter a 2% complete solution to your problem).
My point is, the fact that poor documentation frustrates many people according to a survey does not mean that software developers can't or don't write documentation.
- klodolph 9y ago> It's just that the creator didn't go the last 5% of the way to explain to someone else how. We software developers have this borderline criminal tendency to undervalue work that isn't software development, like writing documentation. I'd say that documentation might be closer to 20% of the work of a project, and developers are usually bad at it (by "bad" I mean "unskilled").
- franciscop 9y agoA -quite old[1]- estimate puts it in 20-40% of the total time should be spent writing documentation. If you find any newer reference please let me know, I'd love to quote it in my project to write project's documentation [2]. [1] http://www.techrepublic.com/blog/10-things/10-things-you-can-do-to-create-better-documentation/ http://www.techrepublic.com/blog/10-things/10-things-you-can... [2] https://documentation.agency/ https://documentation.agency/