Hacker News new | ask | show | jobs
by always_good 3019 days ago
You don't need system insight to improve docs. On one end of the spectrum, docs just need people to improve the language like typos, grammar, and sentence flow.

Also, docs map out the black box but end-users use the black box. They are in a position to find disparities between what the docs say and what the black box does. Like noticing the example response doesn't match the actual response.

Or that if you provide a stream to the API, you must provide a content length, yet this relationship is only marked as optional in the docs.

Maybe an engineer would have to double-check the code to verify the behavior, and that's great.