The Was this helpful? widget at the bottom of every doc lets readers rate the doc and tell you what's missing. Use this feedback to find and fix the docs that aren't working.
📷 Image placeholder: the Was this helpful? widget with Yes and No buttons at the bottom of a doc.
How the widget works
The reader rates the doc
At the bottom of the doc, the reader clicks Yes or No.
The reader explains (optional)
If they click No, they can choose a reason and leave a short comment about what was missing or wrong.
📷 Image placeholder: the feedback form showing reasons and a comment box.
PinkDocs saves the feedback
The rating, reason and comment are saved against the doc and appear in your feedback reports.
Turn the widget on or off
Go to PinkDocs → Settings, open the Doc page options and turn Feedback widget on or off. The widget is on by default.
Read your feedback
Open the feedback report
Go to PinkDocs → Analytics and open the Feedback report.
Choose a time range
Choose the last 7 days, 30 days, 90 days or 12 months.
Review your least helpful docs
Sort docs by Not helpful to see which ones need work first.
📷 Image placeholder: the Feedback report listing docs with helpful and not helpful counts.
Read the comments
Open a doc's feedback to read each reason and comment.
Turn feedback into improvements
| Feedback | What to do |
|---|---|
| Missing information | Add the missing step, setting or example. |
| Hard to follow | Break the task into the Steps block and add screenshots. |
| Out of date | Update the doc to match the latest version. |
| Didn't solve my problem | Check what readers searched for and write a new doc for that problem. |
Common questions
Each reader can rate a doc once per visit, which keeps results fair.
Yes. Readers don't need to sign in to leave feedback.