API Documentation

Share this post

Strategies for improving technical documentation through user feedback

apidocumentation.substack.com

Discover more from API Documentation

Receive tips on Technical Writing, Developer Experience (DX), and Docs-as-Code.
Continue reading
Sign in

Strategies for improving technical documentation through user feedback

How do you solicit documentation feedback from your users?

David Garcia
Aug 21, 2023
1
Share this post

Strategies for improving technical documentation through user feedback

apidocumentation.substack.com
Share

One challenge I consistently face while maintaining technical documentation is ensuring it evolves to match user needs and expectations.

The solution? Actively engage with and listen to your users. Their feedback doesn't just point out what's missing or off the mark but gives a real sense of the documentation's pain points.

In my recent blog post, I shared actionable strategies I've employed to collect and act upon user feedback:

1. Getting feedback before even publishing.
2. The utility of on-page feedback tools.
3. The challenges of user interviews.
4. An original "Escape Room" challenge for user-testing documentation.
5. Using surveys and monitoring channels for feedback.

👉 Here's the article: https://davidgarcia.dev/posts/user-feedback-strategies-documentation/

I'm particularly interested in hearing about your own experiences and methods. How do you approach documentation feedback? Are there strategies that have worked exceptionally well (or not so well) for you?

1
Share this post

Strategies for improving technical documentation through user feedback

apidocumentation.substack.com
Share
Comments
Top
New

No posts

Ready for more?

© 2023 David Garcia
Privacy ∙ Terms ∙ Collection notice
Start WritingGet the app
Substack is the home for great writing