-
-
Notifications
You must be signed in to change notification settings - Fork 272
[📝 Docs]: Change feedback form to actionable questions #805
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
📝 Documentation
Indicates improvements or additions to documentation.
GSoD
Google Season of Docs
Status: Available
No one has claimed responsibility for resolving this issue.
Comments
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 |
1 task
@valeriahhdez Can i be assigned with this issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
📝 Documentation
Indicates improvements or additions to documentation.
GSoD
Google Season of Docs
Status: Available
No one has claimed responsibility for resolving this issue.
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
The text was updated successfully, but these errors were encountered: