You can collect feedback from viewers of your documentation by via the Page feedback feature.

Page feedback settings

The Page feedback section of Styleguide settings enables Admins and Editors to control whether viewers can provide feedback for whole pages and/or individual blocks

If enabled for whole pages, viewers will be see an option to provide feedback at the bottom of every page in the documentaiton.

If enabled for individual blocks, viewers will see an option to provide feedback when they hover over any block in the documentation

👉 Notes:

• Any viewer with access to the documentation will be able to provide feedback
• Organization Admins, Editors and Reviewers can provide feedback in preview mode
• Viewers can provide feedback for the same page/block as many times as they like
• Styleguides created in zeroheight after 4th November 2024 have both settings enabled by default

Providing feedback

When viewers scroll to the end of a page or hover over a block they'll see the option to provide a 👍 or 👎 rating. If they choose an option they'll be able to add an optional comment

View feedback

In Analytics

You can view the feedback from viewers of your documentation in zeroheight Analytics.

The Dashboard tab shows an Average helpfulness rating which shows the number of 👍 ratings divided by the total number of ratings across all pages/blocks for the selected styleguide.

The Page insights tab shows a row for each page in the selected styleguide. The Rating (%) column shows shows the number of 👍 ratings divided by the total number of ratings for the page, the Vote count column shows the total number of ratings for the page.

The Page feedback table in the page level analytics view (accessible by clicking the name of the page in the Page insights tab) shows a row for each individual piece of feedback. Each row shows:

• the date when the feedback was provided
• whether the feedback was 👍 or 👎
• the release of the styleguide where the feedback was provided
• the content that the feedback applied to (e.g. the whole page or a specific block)
• a link to view the feedback "inline" (i.e. within the Editor)
• An option to hide/unhide the feedback, hidden feedback:
  • is marked as hidden in the table
  • is not visible within the Editor
  • still contributes to the Average helpfulness rating and Rating (%) and Vote count

In the editor

Admins and Editors are able to view feedback within the Styleguide editor. If a block or page has feedback (that hasn't been hidden), you'll be able to view the specific feedback alongside the content the feedback applies to.

Feedback can also be hidden from the Editor.

FAQs

If I make a new release of my styleguide, will it reset the page rating percentage?

No, the page rating percentage is for all releases.

What if I delete a page in my documentation that had feedback?

The page will no longer display in the Editor or Analytics>Page insights tab so the feedback won't be accessible within zeroheight but the feedback will continue to contribute to Average helpfulness rating

What if I delete a block in my documentation that had feedback?

The block will no longer display in the Editor but the feedback will still be accessible in Analytics>Page insights tab and will continue to contribute to Average helpfulness rating.

Can viewers of my documentation view the feedback?

No. The feedback is only accessible to zeroheight users with editor access to the styleguide.