3 ms·
> What are other activities, interests that could motivate developers to write documentation? This is the wrong way of looking at it. It assumes a premise that
by karmakaze 5y ago
> What are other activities, interests that could motivate developers to write documentation?
This is the wrong way of looking at it. It assumes a premise that documentation is a goal rather than a means.
To get developers to write documentation there's a few key ingredients. It has to deliver value that the writers appreciate. It has to keep delivering value over long time periods (e.g. stale docs can sometimes be worse than no docs). There has to be a culture/routine of writing documentation and kept as a priority so that it doesn't get cut when there's a time crunch or other work priorities. Oh yeah one other huge one is that it has to have minimal friction: e.g. commit it in the repo with the code changes so that it's no extra steps and the doc changes get reviewed with code changes.
- tra3 5y agoWell said. It’s similar to automated testing. We all agree it’s a must. Lots of hand waving around how important it is, and everyone agrees! I’d say that about 50% of the projects that I’ve been on lacked automated testing. For reasons. I’d say documentation is in the same limbo. We as an industry lack maturity and motivation when it comes to delivery.