TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
>As part of my thesis project I will be doing a survey of our installers and
>end users. I've been doing some general background reading and and found
>several studies and books that cover (both hard copy and online) the
>usability of the literature. The studies seem to concentrate on usability
>from the perspective of "looks" - readability, use of white space and so
>on. It seems to be assumed that the manuals have been properly edited and
>contain all the information they should contain. Am I missing something?
No, but your sources are missing something. Good documentation is not about
the product but about the user. Specifically it is about the use of the
product to perform specific tasks. This being so, you cannot write good
documentation unless you know what your users do. You need to survey them to
discover things like:
What are their tasks?
What are their tools?
What is their level of knowledge and training?
What conditions do they work under? (At the top of a pole? Under six feet of
What regulations govern their work?
Do they make notes or job aids for themselves (and can you get a copy of
Which pages of the current manual are dog-eared? Which are pristine? Which
have comments written in the margin? What are the comments?
Manager, Corporate Communications
OmniMark Technologies Corporation
1400 Blair Place
Canada, K1J 9B8
Email mbaker -at- omnimark -dot- com