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: Summary: Estimating context-sensitive help From:Jane Bergen <janeb -at- ANSWERSOFT -dot- COM> Date:Fri, 21 Mar 1997 08:50:46 -0600
At 02:27 PM 3/21/97 +0000, Katharine Woods wrote:
>I settled on doing estimates at 2 hours per topic for the context-
>sensitive topics and 3 hours for other types of topics. I thought I'd
I have not read the book you cited, but I am curious as to why it would
take less time to write a context-sensitive topic than it takes to write
another topic? Most online developers recommend that online help is
task-based ("How to ..." for a single task). Making it context-sensitive
doesn't require less effort. The topics would be the same, although with
context-sensitive help the software developers have a little more work to
do to call the appropriate topic at the appropriate time.
Maybe you are talking about the "What's this?" topics, which are really
just definitions most of the time. Or maybe there is something about
writing online help that I've missed over the past few years? Another
consideration is that some topics can be created simply by copying-pasting
small sections from the written document. Is this factor considered in the
time allotment?
I apologize if I've missed the original discussion. If so, just e-mail me
privately and tell me to butt out (gently).
Jane
Jane Bergen, Technical Writer
AnswerSoft, Inc. Dallas, TX
janeb -at- answersoft -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html