HACKER Q&A
📣 mlejva

Do you collect feedback for code snippets in your dev docs?


Do you collect feedback for code snippets in your dev docs?


  👤 mlejva Accepted Answer ✓
Hey HN, my co-founder and I have been doing interviews with dev tools companies about developer onboarding, experience, and their dev docs.

One thing we noticed is that dev tools companies don't have a good way of getting more insights on why developers visit their docs. Specifically, feedback related to the code snippets in their docs.

We hacked a quick MVP with yesterday that solves exactly this. Here's a demo - https://twitter.com/mlejva/status/1547931719226912771

It automatically adds feedback buttons to all of your code snippets in your Docusaurus docs and you can start collecting feedback.

What do you think about it? If you are working at a dev tool company, what's your experience? Do you collect feedback in your code snippets?


👤 Jugurtha
What I used to do was to give the dev docs to non-developers (people who never wrote code before) and ask them to follow them. I'd just set up the console and let them take it from there.

Shut up. Look at where they struggled and note the questions they asked (gems). Refine. Ask them again and other people as well to have fresh eyes.

Once the non-developers could go through it easily, I knew the developers would succeed. I'd of course run it by developers as well.

A few iterations were enough.