On-Page Feedback

We are working on the last piece of the puzzle, feedback.

With DeveloperHub, you’re able to now write docs, get reviews, look at data/analytics and lastly we need feedback from your readers, so you can iterate to keep enhancing your docs.

Our initial thoughts of how it works would be to introduce a like/dislike button at the end of each page with “Was this page helpful?” question, which prompts for more information when clicked, but registers the sentiment regardless.

We would like to hear from you, what would you want to do with these sentiments/messages afterward?

  • We realise that you’d want to track the sentiment over time to ensure that your docs are enhancing, but what would you do with the messages? Would negative feedback be moved to an external ticketing system (jira), or just to a Slack channel? Or would it just suffice to have it in DeveloperHub where you can mark it as read?

  • How about positive feedback?

  • Who would be responsible for feedback, would it be the contributor of the page, or someone else in your organisation?

  • Would you want to capture the readers e-mail address? Would you enforce it? You may also inject the user’s email address/ID using injected variables.

Let us know!

3 Likes

Hi Zaid,

I would love this feature. We constantly want to make our documentation better and if we are unsure how some pages are doing it would be great to have either:

  • like or dislike button
  • star rating.

This way we can improve a page if it deems unhelpful. In answer to the questions above:

We realise that you’d want to track the sentiment over time to ensure that your docs are enhancing, but what would you do with the messages? Would negative feedback be moved to an external ticketing system (jira), or just to a Slack channel? Or would it just suffice to have it in DeveloperHub where you can mark it as read?

We raise all document enhancements to JIRA.

How about positive feedback?

We log our positive feedback only as its very motivating for the team and its good know what works well.

Who would be responsible for feedback, would it be the contributor of the page, or someone else in your organisation?

All the team, but mainly feedback for the contributor

Would you want to capture the readers e-mail address? Would you enforce it? You may also inject the user’s email address/ID using injected variables.

No, we are happy to not have contact details for now

1 Like

plus 1 from Platform9.
Positive and Negative are all the same to me, and I would treat them as equals.
It would be awesome to be able to integrate into marketing automation so we can reach out to the user.
Segment integration may be a great start, as sending an “event” into Segment then means that users are able to forward the event to one of the many downstream systems that already supports Segment.
Being able to capture identifying properties would be useful, email as it supports out reach, that said data privacy concerns are a consideration here. I would make these optional.

2 Likes

Hey Zaid,

This is a great feature and will be really helpful for our doc improvement.

  • Tracking within DevHub would be good for now. Same for positive feedback.
  • May be the Admins of the project can have access to this information.
  • Capturing reader’s e-mail may be optional. We wouldn’t need that information for now.

Suggestions

  • A ‘like-dislike’ button would be helpful.
  • Can we have an option (like a small button or icon) where customers can send a detailed email of their feedback, if interested?
  • An option to obtain insights from this data would be great - something like what Google Analytics does.
1 Like

We realise that you’d want to track the sentiment over time to ensure that your docs are enhancing, but what would you do with the messages? Would negative feedback be moved to an external ticketing system (jira), or just to a Slack channel? Or would it just suffice to have it in DeveloperHub where you can mark it as read?

  • I like the idea of something simple like a thumbs up or down, but it would be nice to have a text field where the reader could provide feedback, so they could say something like “This answered X, but I wanted to know about Y”, I want to know what “Y” is.
  • If this could hook into Jira, that would be excellent, otherwise and email notification would be plenty.

How about positive feedback?

  • I think a thumbs up is enough for me

Who would be responsible for feedback, would it be the contributor of the page, or someone else in your organisation?

  • Likely a contributor.

Would you want to capture the readers e-mail address? Would you enforce it? You may also inject the user’s email address/ID using injected variables.

  • Not required, but would be good know
1 Like

Feedback would be great. Thumbs-up / Like or Thumbs-down / Dislike would be ok – rating 1:5 would be better IMHO. Right now, I’d just track this in DeveloperHub, but I could see linking it to Jira as the doc team grows. Hopefully any such feedback could be logged against the page for later review (to see if feedback improves).

I’ll take feedback – positive or negative does not matter to me. It is all an opportunity to correct, augment, and/or improve. Perhaps feedback could be assigned as a role/function in the current DeveloperHub Team/Collaborator control panel?

I would love to have an entry field where readers could ask for what they don’t see, or suggest doc additions.

It would be great to have the user’s email if they were willing to provide… to follow-up as needed for clarity or to notify that their feedback was addressed. Don’t require it but offer it as an option to provide. I have some requests already for requiring user accounts in DeveloperHub so that we could track what has been read… an email might be a good start at that, but with the changes in privacy, ID, and cookies, that could get messy FAST.

1 Like