How to check understanding of user documentation?

Question

Programming

How does your company check user documentation for a software product? Who is doing the verification? What criteria are taken into account in such a check? How do you make sure that the documentation is understandable to the one for whom it is, in fact, intended - the end user?

I would be grateful for interesting materials on the topic, as well as instructive stories from practice.

Answer 1

Everything is done quite simply with us:
1. The documentation is checked by the one who requested it. As a rule, this is a project manager, or an employee from the support and implementation department.
2. And, of course, after providing the documentation to the end user, we collect feedback, which is also amended.
Criteria - in fact, the question is not unambiguous, because. for various types of documentation, different criteria and factors are prioritized. In the general case, of course, spelling, punctuation and other rules of the language (including the logical construction of sentences), the correct use of terminology, consistency and structure. Something like this. If you have any questions, feel free to ask and I'll try to answer.