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: Planning before writing on-line help From:Faith Weber <weber -at- EASI -dot- ENET -dot- DEC -dot- COM> Date:Fri, 4 Mar 1994 10:07:26 PST
I just wrote my first (small) online help file. I, too, recommend the
book "Developing Online Help for Windows", which helped me get
a feel for the overall process of developing help.
Before I got started, I created an outline containing topics for
procedures, reference information, and definitions. That
really helped me get an idea of what I'd cover in the help file,
even though the actual structure of the help changed a couple
of times. (I imagine you'd want to establish the structure
more firmly before coding a large help file; mine was only 45 topics,
so changing it was not a big deal.)
If possible, I would strongly advise verifying as much
of the information as you can before you start coding.
I started with a very system- and programmer-oriented spec, eagerly
started coding early (which admittedly served the purpose of getting
me familiar with the process), then found out my interpretation of
some of the spec was wrong, and I had to completely change parts of
It can be difficult to get a decent review of help file contents
until you've coded because the help is hard to visualize from paper,
but it helps to at least be sure of the information you're covering
before you start! (Easier said than done, but . . .)
EA Systems Inc.
weber -at- easi -dot- enet -dot- dec -dot- com