How to Write Documentation That’s Actually Useful

Programmers love to write code, but they hate to write documentation. Developers always want to read documentation when they inherit a project, but writing it themselves? Feh!

How common is this? A recent GitHub survey found that “incomplete or outdated documentation is a pervasive problem,” according to 93 percent of respondents. Yet 60 percent of contributors to the open source code repository say they rarely or never contribute to documentation. Their reasoning, for both the open source projects and their own applications? A common attitude that “documentation is for ‘lusers‘ who don’t write good code!”

That’s not a stance your business can afford to adopt.

Leave a Reply

Your email address will not be published.