: Problems with getting meaningful and actionable feedback from readers As someone who doesn't get paid to write stuff nobody reads :), I'm always on the lookout for the best ways to collect meaningful
As someone who doesn't get paid to write stuff nobody reads :), I'm always on the lookout for the best ways to collect meaningful and actionable feedback from my readers so I can improve the quality of the docs I write.
What kind of strategies/tools/etc. do you guys use for this?
EDIT:
Let me clarify what I mean by "meaningful and actionable feedback":
To get meaningful feedback from our readers:
We must focus only on the most important issues from the readers' point of view.
We must ask only the fewest possible number of questions that can cover all of these important issues.
The terminology we use must be clearly and universally understood by all respondents.
For feedback to be actionable, it must meet the following criteria:
The readers' responses must be unambiguous.
The issues that the respondents are concerned about must be easily understood and easily addressable by the people the feedback is intended for.
More posts by @Hamm6328258
: "Graphics" skills are nice to have a skill for technical writes. In some cases (but not all) graphical representation of the information is really crucial. But who will do the graphics, images,
: Can I place a fictional neighborhood in a real city? I don't know if it's possible or not but could I place a made up neighbourhood in a city say New York? Or in any city? Can I change
2 Comments
Sorted by latest first Latest Oldest Best
I'd recommend identifying your 'power users' and work directly with them.
As in all situations the people your documentation is aimed at will differ. Those that do not read at all, those that refer to the documentation only after all else failed, and on the other side of the spectrum the guys that read the new release cover to cover and send you a memo pointing out every single typo and then some.
If the no-readers are on the left and the memo responders are on the right you need the rightist middle ground. Long-time users deeply entrenched in the subject matter that help out the newbies would be ideal. I called them power users but a more precise/formal term might be Business Analyst if that is actually a position in your company.
Now you need to find one or more guys with this skill set able AND willing to sit down for a thorough analysis of the document you want to tackle. Be prepared for feedback that another document needs attention more urgently and/or other suggestions quite out of the box.
How to find them? Any sort of user organisation will know, or more likely have such a person as chair.
In my experience this is the fastest and most effective method to push your output to the next level (and beyond).
This depends somewhat on the audience. You could have internal corporate docs that can only be viewed by coworkers, publicly available docs that everyone can see, etc. Certainly a comments section is a good start, as is contact information for personalized support.
Generally there is also a review process to get the docs published in the first place. This is best handled by making review and sign-off a requirement that is enforced by project management, and not an informal process.
For example, if you are using a project management system like Jira, Remedy, etc. the item should be added to the task for the SME or someone similar and only closed out once that review process has been completed.
Terms of Use Privacy policy Contact About Cancellation policy © selfpublishingguru.com2024 All Rights reserved.