Evaluate methods to get feedback (surveys, feedback button, ...)

[sypets]

Currently, I see the following use cases / ways how feedback could be obtained:

1. Get feedback for new things before going live. For example, a manual has been restructured, the start page redesigned, there are changes in the theme. Maybe there are 2 or more different designs to choose from.
2. Collect specific feedback about documentation in general or specific manual via a survey. These can help to structure feedback, categorize and quantify it.
3. Feedback button on pages, with possibility to rate and / or comment
4. Automatic feedback (e.g. usage statistics) via Analytics / Matomo, Logs, Google Search Console etc.
5. Direct feedback (in person)

Which of these methods do we need? How can they be implemented?

This writing.stackexample.com question lists a few: https://writing.stackexchange.com/questions/33520/problems-with-getting-meaningful-and-actionable-feedback-from-readers

Resources:

• Phil Davis: Applied Empathy: the Unique Value of Technical Writers and User Advocacy (2019)
• Kayce Basques: "Maybe Our Documentation "Best Practices" Aren't Really Best Practices"

Related:

• Add a "report issue" or "report problem" button

[sypets]

For 2. limesurvey might be a useful tool. It can be used selfhosted or you can buy a hosting package for a yearly rate. Also, this is not only interesting for the documentation, but for TYPO3 in general.

[sypets]

More Examples

1. Twilio: rate + comment

Twilio: https://www.twilio.com/docs/voice

2. google developer: "Was this page helpful"

https://developers.google.com/web/tools/chrome-devtools/css/#feedback

3. Google Season of Docs

4. docker

https://docs.docker.com/docker-for-mac/faqs/

The "Request doc changes" just links to GitHub new issue (and inserts URL in body)

5. typo3.org uses Disqus to add comments

e.g. https://typo3.org/article/docstypo3org-gets-new-infrastructure/

see

• https://www.webnots.com/how-to-add-disqus-to-your-website/
• http://disqus.com/api/docs/

6 Gitlab: Help + Feedback on right column

Help + Feedback > Docs Feedback:

• edit
• go to issues
• open comments

https://docs.gitlab.com/ee/user/project/repository/branches/#help-and-feedback

[sypets]

Old issue, low priority, nice to have feature.