Open valeriahhdez opened 3 months ago
This needs to be coordinated with #762.
Good ideas here. We just need to be sure we're not losing the ideas in the other issue.
I can make this form better , @benjagm should i start working on it ?
The cue to start on something needs to come from @benjagm.
Done! Created a PR for this issue please check it out. Thanks
What Docs changes are you proposing?
Instead of asking readers if the docs were helpful and allowing writing more details, which is sometimes filled with ambiguous statements, we need to ask questions that give us unambiguous, actionable information. Based on his research on readers' expectations from documentation, Yoel Strimling concludes the most important aspects for readers is that documentation is:
Based on this observation, Strimling recommends to ask four Yes or No questions to retrieve actionable feedback:
This proposal therefore suggests replacing the open-ended question Was this helpful? with the above questions. It leaves the opportunity to create an issue in case the problem our readers encounter is not covered by these questions.
Code of Conduct