Skip to content

[📝 Docs]: Change feedback form to actionable questions #805

Open
@valeriahhdez

Description

@valeriahhdez

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

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    GSoDGoogle Season of DocsStatus: AvailableNo one has claimed responsibility for resolving this issue.📝 DocumentationIndicates improvements or additions to documentation.

    Type

    No type

    Projects

    • Status

      Idea

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions