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: Time to integrate online help? From:Virginia Day <Virginia_Day -at- DATACARD -dot- COM> Date:Fri, 19 Dec 1997 10:40:15 -0600
The alternative is have the developers identify the resource strings
and numbers (IDs) for each item (button, dialog, etc) that gets
context-sensitive help and give you a header file with the
information. Some development environments generate this stuff
automatically, and some programmers like having this control--my
developers have a system for creating the IDs.
You will have a few questions about what similarly-named items
actually identify. After you receive the header file, use your HAT to
associate topics with resource IDs. When you compile, your help file
will be linked to the items in the application.
HTH, Virginia
______________________________ Reply Separator _________________________________
Subject: Time to integrate online help?
Author: geoff-h -at- MTL -dot- FERIC -dot- CA at Internet
Date: 12/19/97 10:05 AM
Jill Scudamore is <<starting to investigate the
possibilities of implementing on-line help and context
sensitive help. In order for my proposal to be accepted, I
need to provide an estimate of the amount of time that the
programmers will need to work with my files in order to
integrate them into the applications.>>
It depends mostly on what kind of bells and whistles you're
implementing in the help (e.g., multimedia elements may
take longer), but on the whole, it's about as painless and
fast as anything in the world of computing. Case in point:
I compiled my help file, automatically generated a file
with the context numbers, printed up the screen shots for
each screen, and explained which context number went with
which screen shot. The programmers went into the source
code, did a search to find the correct portion of the code
for that screen, and typed in the context number. They
recompiled the application, and bingo: context-sensitive
help.
How long will this take? From what I saw, it took the
programmers less time to enter the context numbers and
recompile than it took me to generate them and print the
screen shots. Of course, they have nicer computers than I
do! YMMV.
--Geoff Hart @8^{)} geoff-h -at- mtl -dot- feric -dot- ca
Disclaimer: Speaking for myself, not FERIC.
