We posted a question on LinkedIn and Twitter, “In five words, sum up your user documentation/user assistance”. Here are the replies we received:
Technically correct, complete, searchable example
Structured, concise, translatable, unrepetitive, transformable
Dr Meghashri Dalvi
Get more out of it!
Makes you effective and efficient!
Keep it crisp and clear…
Collaborative documentation easing user adoption
Craig Wright – Tech Writer
Who, why, when, how, consequences.
Hmmmm….”task-oriented, audience-appropriate minimalist”?
What can we take from this? I think it shows that Technical Authors are interested in efficiency – creating content in an efficient way, and giving users the information they need in an efficient way.
What are the five words you would use? And, do you spot a common theme?