Hacker News new | ask | show | jobs
by secoif 5360 days ago
Being stuck due to shitty docs is the worst. Particularly when docs are wrong, leave our crucial info, or the examples don't work (!).

Developers, please take pride in great documentation, and if you get stuck due to someone else's shitty docs, tell them at least, at best: fix the docs yourself. You can often write great (passionate) docs if you just had hands-on experience with the pain-points.

Also, make sure your examples work (examples+tests are often the best docs)