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.
Subject:RE: How do you read a User Manual From:"Colin Ramsden" <colin -at- ramsden -dot- info> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 17 Jun 2004 00:54:26 +1000
Fred.
That's fantastic.
Can you make these (or some useful part of your) usability results
available? Even just for objective statistical purposes and analysis?
I'm not concerned with the subjective results of your proprietary product or
its good/bad points. I am, however, VERY interested in the results of how
(and maybe why) your users interacted with your documentation, both printed
and online in a non-proprietary manner.
Please note that I do not (wish to imply that I) question you or your
abilities or the quality of your documentation. I would just like to see how
your users actually used the documentation. It is purely a query of
usability, and as you've stated that your employer has gone to the trouble
of actually performing usability studies of the documentation, I'm
interested in the results, or at least, whatever you're prepared to share
with us for our documentation usability education and edification.
You only mention use of the index. Is that their "primary" entry point for
both printed and online help? Or which? Please share.
Do you have details about "how" your users went about finding what they're
after?
[Insert a further several (hundred) usability questions here.]
Please share with us what you can (given proprietary considerations).
Colin Ramsden.
-----Original Message-----
From: bounce-techwr-l-158987 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-158987 -at- lists -dot- raycomm -dot- com] On Behalf Of Fred Sampson
Sent: Wednesday, June 16, 2004 9:25 AM
To: TECHWR-L
Subject: RE: How do you read a User Manual
My current employer (a Large Enterprise Software Company) has actually done
usability studies with users of our documentation (which is delivered both
in print and as online help). And, wonder of wonders, some folks are
actually paying attention to the usability studies.
The answer: users go to the index to find what they need (or think they
need); online, they use the index and search about equally. They don't read
from beginning to end.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.