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: QUERY: Baby steps to Windows online help From:"Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM> Date:Wed, 31 Jul 1996 18:14:44 -0700
At 04:35 PM 7/31/96 -0600, Patty Ewy wrote:
>I work for a third-party software development company. Until recently, the only
>role the tech writers here have had in the development of our online help is to
>export the text from our PageMaker files.
>Now we need to get our feet wet in the Windows-style help. But where to start?
>Our product is immense (more than 100 "major" windows, with lots and lots of
>inquiry and lookup windows). Our tech writing team works on Macs (the rest of
>the development staff is on PCs). All our text is in PageMaker files. And while
>we have a developer who has spent sometime looking into options that are
>available to us for developing the online help system, the development staff is
>keen to give the entire project to the tech writers. We have no tech writers
>with any online help experience.
>If you were in this leaky boat, what's the first step you'd take? Just send
>someone off to a training seminar? (Or do they expect you to have a pretty good
>idea of the help tool before you get there?)
Well, Patty. Step one is the hardest. Scrap those Macs and get your
group some PCs to work on. Not only do you need them to develop the
help on, you need them to become familiar with the platform, the
conventions, and *other* help files. One of the best ways to become
familiar with online help for a platform is to *use it* so you can
see how it works, what works well, and what falls short of the mark.
Until you do that, you'll be developing in the dark. And Windows help
ported to the Mac is nothing like Windows help on Windows.
Second step is read. Winhelp Journal, STC Online PIC newsletter,
books on online help, product reviews... Learn what the issues are,
what the tools are, feel your way around. Probably have someone in
the group subscribe to the winhelp list.
You'll have to pick a tool eventually. Take your time and select
the one that the group is most comfortable with. They all do the
same thing, but some of the approaches are very different. Get
Seminar? Maybe. But, to learn the paradigm or to learn the tool -- or
both? They'll more than likely be two separate classes. What's the
Spend some time organizing and planning -- implement the help in stages.
Maybe first round is context-sensitive only, second round is to add
procedures. Take it in small bites. Once you get going, you'll wonder
what took you so long. ;-)
sgallagher -at- expersoft -dot- com
-- The _Guide_ is definitive.
Reality is frequently inaccurate.
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-