DX and UX: implement docs feedback mechanism

[barriebyron]

Docs feedback has multiple benefits:

• Learn about user perspectives
• Identify friction points
• Engage community
• Help users succeed

Food for thought: Microsoft journey https://learn.microsoft.com/en-us/teamblog/a-new-feedback-system-is-coming-to-docs

I know the tech writer at https://www.designmaster.biz/help/electricalrt/usermanual/ where docs are built with Docusaurus. They implemented feedback with Feedback Rocket, and found it to be pretty straightforward to set up: Create an account on their website, get your ID number, paste a few lines into your docusaurus.config.js file, and enter your ID number in the appropriate spot. Then, still in the config file, add a few more lines where you define what shows up in your top nav to add a link for the feedback widget. See the widget beside the search bar on our docs if you wanna give it a whirl: https://www.designmaster.biz/help/

MongoDB example: I like this simple widget https://www.mongodb.com/docs/manual/core/data-modeling-introduction/

GitHub example: https://docs.github.com/en/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/managing-access-for-github-enterprise-importer

GitLab example: https://docs.gitlab.com/ee/tutorials/infrastructure.html click a banner to show

DataStax docs (I'm an alumni) 1-5 stars (not so fond of ratings that can skew) https://docs.datastax.com/en/astra-cli/docs/0.2/

Biconomy doc feedback, comment when select No https://docs.biconomy.io/

[barriebyron]

examples of docs feedback mechanisms

Google Cloud https://cloud.google.com/docs

GitHub https://docs.github.com/en

[barriebyron]

Feedback is most useful when it is actionable. My preference is to gather WHY information when a response is NO (not useful). If a user responds "NO" to a "is this page useful?" then what do we do next? We must gather the WHY

Some feedback mechanism backend system auto-create a docs issue when developmental (critical) feedback is given.

[barriebyron]

this issue is an active DevRel active initiative

[dgarcia360]

Hi! @barriebyron! I found this issue while searching for "feedback widget" on GitHub.

I'm building PushFeedback, a feedback widget tailored for docs sites that integrates well with Docusaurus.

Feedback is most useful when it is actionable. My preference is to gather WHY information when a response is NO (not useful). If a user responds "NO" to a "is this page useful?" then what do we do next? We must gather the WHY

I agree. I was thinking PushFeedback could fit your use case since the widget can be triggered from any button, for example, when a user selects a thumbs down icon.

We have a free plan for open-source projects in exchange of keeping the widget branding. If you're interested in exploring integrating PushFeedback, please sign up for an account and let me know to remove the limitations for your project.

Additionally, I'd be more than happy to assist with a pull request to integrate the Docusaurus extension.

Looking forward to hearing from you!