3 ms·
Is there a good place to go for critiques on your project's documentation? I'm currently working on updating the API docs for the company I work for, so we're
by afarrell 10y ago
Is there a good place to go for critiques on your project's documentation?
I'm currently working on updating the API docs for the company I work for, so we're paying people. However, what should open source projects do?
One thing I've seen that works poorly is encouraging new contributors should work on the documentation. The problem with this is that a new user only has knowledge of what they are confused by--not the broad understanding of the project that allows them to compose a document that teaches a coherent mental model. It seems like that can only be done by someone who is familiar with the project, but then they need a way to test that their writing actually makes sense.