Skip to content

Use case

Documentation Feedback

Find the missing step, unclear example, or outdated page. Ask readers what helped and what still needs work.

The Pollenate Team

A helpfulness prompt gives readers a way to tell you which documentation needs attention. Put a short question beside the content, capture the page it refers to, and use the explanation to make a specific improvement.

Pollenate provides thumbs, stars, emoji, and text widgets, with an inbox for the responses. For documentation, start with “Was this helpful?” and an optional comment.

Put the prompt where the question is still fresh

Place an inline widget at the end of an article or after a self-contained task. A rating on your entire documentation site is less useful than a response attached to the setup page that caused the problem.

For a site that permits custom HTML and JavaScript:

<div id="docs-feedback"></div>
<script
  src="https://pollenate.dev/widget.js"
  data-inbox-key="YOUR_INBOX_KEY"
  data-api-key="YOUR_COLLECT_KEY"
  data-type="thumbs"
  data-prompt="Was this article helpful?"
  data-container="#docs-feedback"
  data-theme="auto"
  data-context='{"surface":"documentation","version":"v2"}'
  data-strip-query-params="true"
  defer
></script>

Create the inbox and a collect-only organization key first. The container must exist when the script runs. If your documentation framework uses React or client-side routing, use the React and Next.js implementation guide and test navigation between articles.

Check whether your documentation host permits custom scripts and styles. There is no requirement for a framework-specific Pollenate plugin, but a hosting platform’s restrictions still apply.

Collect the context you will need to fix it

The widget records the submitted page URL. Use data-context to add a documentation version, product area, or release identifier. That helps distinguish feedback on an older API guide from a current problem.

For a documentation site with section-level feedback, pass the section identifier yourself. Pollenate does not infer the exact paragraph a visitor meant from a general article rating.

Do not add access tokens, private document contents, or unnecessary reader identifiers to feedback metadata. Review your URLs, especially if they carry query parameters.

Make the response actionable

A simple review routine is enough to start:

  1. Read new negative ratings and their comments.
  2. Open the affected page and reproduce the missing or confusing step.
  3. Link the feedback to the issue that tracks the correction.
  4. Update the article, then inspect subsequent responses.

You can configure email or webhook automations to route incoming events. Sending an event to a service that creates a GitHub issue requires that service or automation to be configured; do not expect an issue to appear merely because the widget is installed.

Semantic search can help find related comments written in different words. Read the matched feedback before treating it as one problem. A small set of responses is a useful lead, not a measurement of every reader’s experience.

Check the experience on your own docs

Submit one helpful and one unhelpful test response. Confirm that each arrives in the expected inbox with the correct URL. Test a route change, mobile layout, dark mode, keyboard navigation, and any consent controls on your site.

Keep the prompt visible without obscuring code examples or the next-step navigation. After a documentation change, compare feedback from similar periods and consider how many people actually responded.

Add feedback to your docs, follow the script installation guide, or explore the feedback API for your own interface.

Frequently Asked Questions

How do I add feedback to a documentation site?
Use an inline Pollenate widget beneath the article. Create an inbox and collect-only organization key, then follow the script or React installation guide. Your documentation host must allow the required custom code.
Does feedback automatically create a GitHub issue?
No. You can link feedback to an issue and use email or webhook automations. Creating an issue automatically requires a configured integration or service that receives the event and creates it.
Does Pollenate know which article was rated?
The widget records the active page URL when feedback is submitted. Pass additional context, such as documentation version or section, yourself.

Get your first useful response

Add a focused prompt to your product, submit a test response, and see it in your inbox.