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.

Motivating Developers to Care About Documentation

16 pointsby nelsonmarcosabout 3 years ago

3 comments

cc101about 3 years ago
It's not a matter of motivation. Programmers reduce the verbal understanding of their work to non-verbal symbolism. That's necessary to work efficiently in long complex projects where many ideas have to be manipulated. It is very distasteful to re-verbalize work that has been reduced to symbolism.
评论 #31148019 未加载
tedyoungabout 3 years ago
&gt; If you’re taking documentation really seriously, put it on the scorecard. Look for good writers. ... Then put it in your career ladders too. It’s a competency that individuals need to develop if they’re to move to the next level.<p>Exactly. If it&#x27;s not evaluated and rewarded in the same way shipping code is (in hiring, too, as mentioned), it&#x27;ll never be treated as important by developers. Devs are generally rational: if you say &quot;write docs!&quot;, but then complain when things take longer because they were taking time to write docs, well, then you can guess what will happen.
pydryabout 3 years ago
IME the biggest killers of documentation are:<p>1) no time set aside to keep it up to date.<p>2) the tedium of reflecting changes made in one place in 3 others.<p>3) the fact that the MVP of a lot of organizations is the go to guy who can answer all the questions while amazing documentation is quickly taken for granted &amp; rarely personalized.