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:Usability and role of tech writer? From:smithelizabeth -at- hotmail -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 14 Nov 2003 10:02:18 -0700
The software product I write online help and other documentation for has
undergone a change within Product Marketing. As a result, they do not seem
to think as highly of the product as the previous team, and have requested
a "usability audit." This is partially because although we have a web
-based application, the UNIX-based system is still an option. Fully 25% of
our customers still use the UNIX version, and this may be affecting sales.
I've been asked to provide a crude estimate of hours required to
review/audit the Help screens, which I gave at 500 hours. The team leader
for the front end estimated that for the other parts of the system, he'd
need to go through about 200 screens to do a comprehensive audit...page by
page. He estimated it would take about 7 hours per screen, on average, to
run an audit. Some would take minutes, while others would take hours, so
7 was the magic number. I've been asked to use similar logic with the
help screens, if possible.
However, I think that the interface itself needs a redesign (alignment,
color, proximity, typography is relatively amateurish). From my
perspective, you have to define what is "usable" before you know what you
have to do to enhance usability. At the very least, maybe checklists could
be used as a benchmark for comparison. I think part of the problem with
this audit is that no one provided a definition of what exactly
"usability" is, so we don't know what criteria to compare our product
I am really getting frustrated, especially since he haven't had a human
factors person in a couple years, and developers don?t seem to understand
what I mean about graphic design and usabililty. What should my role be?
I am very confused and would love advice on how to handle this situation.
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4
You are currently subscribed to techwr-l as:
archive -at- raycomm -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.