website icon indicating copy to clipboard operation
website copied to clipboard

[📝 Docs]: Change feedback form to actionable questions

Open valeriahhdez opened this issue 1 year ago • 6 comments

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:

  • Easy to find
  • Accurate
  • Relevant
  • Easy to understand

Based on this observation, Strimling recommends to ask four Yes or No questions to retrieve actionable feedback:

  • Could you find what you were looking for?
  • Was it accurate?
  • Was it relevant?
  • Was it easy to understand?

Screen Shot 2024-07-18 at 11 24 37

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

  • [X] I agree to follow this project's Code of Conduct

valeriahhdez avatar Jul 18 '24 17:07 valeriahhdez

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.

gregsdennis avatar Jul 18 '24 20:07 gregsdennis

I can make this form better , @benjagm should i start working on it ?

DevMhrn avatar Jul 25 '24 16:07 DevMhrn

The cue to start on something needs to come from @benjagm.

gregsdennis avatar Jul 25 '24 21:07 gregsdennis

Done! Created a PR for this issue please check it out. Thanks

harshsbhat avatar Aug 02 '24 16:08 harshsbhat

@valeriahhdez Can i be assigned with this issue.

Kashika23 avatar Mar 06 '25 15:03 Kashika23

Hello! :wave:

This issue has been automatically marked as stale due to inactivity :sleeping:

It will be closed in 180 days if no further activity occurs. To keep it active, please add a comment with more details.

There can be many reasons why a specific issue has no activity. The most probable cause is a lack of time, not a lack of interest.

Let us figure out together how to push this issue forward. Connect with us through our slack channel : https://json-schema.org/slack

Thank you for your patience :heart:

github-actions[bot] avatar Oct 05 '25 02:10 github-actions[bot]