We need a way to collect the user feedback about our technical documentation. Feedback from users will lead to improved current documentation and will help us to understand the problems.
There are two requirement:
- User should able to give feedback on quality of documentation
- User should able to leave generic positive/negative feedback with description
Method 1: Feedback gadget with event logging
In this way, we can use Gadget-userfeedback.js to collect feedback.
But this method had very limited impact. Example: On API documentation, only 38 responses were received out of 67,000+ pageviews. Also, it requires someone from WMF staff to query the feedback as data is being stored on Wikimedia’s hive which requires privileges.
Method 2: Collect feedback on centric JSON page
In this way, we can create a Gadget that will collect feedback from users on the page and will store the data on a centric JSON page on the wiki through AJAX.
It has some privacy issues as we can store the data only for 90 days. Also, all feedback will be public so there will not be any chance to delete data after 30 days.
Method 3: Redirect them to a centric talk page
In this way, we can create a template and put it on every page. In template, we will ask users to go to a centric talk page like Manual_talk:Maintenance_scripts and leave the feedback there.
Method 4: Collect through Google Form
Create a Google form and send it to mailing lists, village pump, and user’s talk pages. In this way, we can collect the data but this is not sustainable and it can be used for a very limited time. Also, users will not be able to give feedback any time as Google form will have closing dates at some point.