HN Explorer

Ask HN: Why do you write documentation?

1 points by KennyFromIT ↗ HN
Mostly everyone I talk to says they don't like to write documentation. Why is that?

What ultimately forces your hand and compels you to document things?

What are examples of great documentation (i.e. easy to write and/or consume) that you've seen?

4 comments

[ 3.4 ms ] story [ 22.2 ms ] thread
EddieDante
> Mostly everyone I talk to says they don't like to write documentation. Why is that?

I hate writing documentation. You know what I hate even more? Having to talk to people. I got into this trade so I wouldn't have to talk to people, dammit.

rzzzwilson
Needing to understand my code in six months time. Making it easier for others to maintain my code. Making it easier for others to install my code. Making it easier for others to use my code.

If you or anybody else doesn't use your code after it's written, don't document it.

bradwood
Avoiding having to repeat myself
prirun
As a solo developer of HashBackup, good documentation allows me to work on what I enjoy - coding - rather than answering tech support questions caused by inadequate documentation. I actually enjoy writing documentation now, since it enables people to take full advantage of the software all on their own.