TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Why do you write documentation?

1 pointsby KennyFromITalmost 3 years ago
Mostly everyone I talk to says they don&#x27;t like to write documentation. Why is that?<p>What ultimately forces your hand and compels you to document things?<p>What are examples of great documentation (i.e. easy to write and&#x2F;or consume) that you&#x27;ve seen?

4 comments

EddieDantealmost 3 years ago
&gt; Mostly everyone I talk to says they don&#x27;t like to write documentation. Why is that?<p>I hate writing documentation. You know what I hate even more? Having to <i>talk</i> to people. I got into this trade so I wouldn&#x27;t <i>have</i> to talk to people, dammit.
rzzzwilsonalmost 3 years ago
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.<p>If you or anybody else doesn&#x27;t use your code after it&#x27;s written, don&#x27;t document it.
prirunalmost 3 years ago
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.
bradwoodalmost 3 years ago
Avoiding having to repeat myself