Survey: What makes for high-quality documentation?

  • 2
  • Article
  • Updated 1 year ago
A technical writer in the industry reached out to me to see if the TechSmith customer community could help with a research project he's conducting. If you can take a few minutes to respond to his anonymous survey about how readers define documentation quality, please do:

https://www.surveymonkey.com/r/JSK9ZL9


The survey asks you to rate the importance of 15 documentation quality dimensions, as well as consider how their presence/absence in technical documentation makes you feel. The survey is not about any particular company's documentation, but rather about technical documentation quality in general.

Thanks!
Photo of Daniel Foster

Daniel Foster, Snagit strategy lead

  • 907 Posts
  • 208 Reply Likes

Posted 1 year ago

  • 2
Photo of Joe Stoddard

Joe Stoddard

  • 16 Posts
  • 17 Reply Likes
That survey is ridiculous, beyond poorly written. I also gave up It's not going to generate any usable/actionable data for you IMO. That said let me say that I would EXPECT all 15 of your adjectives about documentation to be present and true, and if I encountered documentation at a client that did not - it would be replaced. Period. There is priority however. Accuracy is CRITICAL and would take priority over minor formatting issues or writing style.