Tell me more about how people hate writing documentation, and then tell me how they can't shut the fuck up about not having it when they need it.
This is a peeve of mine.
What do you expect?
Tell me more about how people hate writing documentation, and then tell me how they can't shut the fuck up about not having it when they need it.
This is a peeve of mine.
What do you expect?
A better approach is to learn just enough to do it yourself, but it's not easy to document things well.
I like to think about documentation like this: Without it your work will be almost wasted as nobody can make use of it. That helps a bit :)
Simple things like a linter that yells at you if a class has an undocumented method would probably at least be a step in the right direction. People may complain that it would lead to overdocumentation but I'd argue that it's probably better than underdocumentation.
Even something as simple as providing a warning when there appears to be an long code block without documentation would probably be a step in a decent direction. What seems trivial and obvious today likely will not in a matter of weeks - and it generally just gets worse from there.
Of course that can lead to developers just adding a single line comment with the name of the type ... but it's still a nice feature.
IME, the only thing that works is to attack it from a Project level: make usable documentation (needs a review before being signed off) a deliverable or the project isn't done.
The thing is, I don't this happens in isolation. At least not for me. I hate writing documentation because time is not allotted for it. So I have to rush it, and in the process I feel like I'm doing a poor job, which is demoralizing. I'm gonna dread it next time I have to do it.