Re: TECHWR-L Digest, Vol 13, Issue 22 RE: Help question and acronyms in help

Subject: Re: TECHWR-L Digest, Vol 13, Issue 22 RE: Help question and acronyms in help
From: wsfn <WSFN -at- rocketmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 22 Nov 2006 02:40:25 -0800 (PST)

I was going to reference the appropriate previous
emails, but the list was so long, I gave up
searching for the snippets.

Issue 1 -- What help tool do you use and how
would you approach multiple customers who need to
append information to your help system.? -- I use
RoboHelp and I think I would recommend (based on
your brief description) that you provide a link
to an external html file opening in a new window
(with appropriate exit information in the tag).
The customers are then responsible for creating
and maintaining this first file as you define
(naming especially) and they deal with the fact
that they either must have a second help system
created by them using a template from you, or
non-pretty files that aren't truly help files,
but just linked html pages. It really depends on
how extensive the addendum is. If it is one
page, you are golden. Otherwise, it can get ugly
quick... but at least your help system won't be

Issue 2 -- using the logic of first occurrence
acronym spell outs to a help system -- I would
not, and I am a full-blown Fed/DoD type document
producer. For help (my specialty), I use a
glossary function that is always available. In
very rare cases, I will explain a term in context
if I KNOW it is unique or foreign to my audience
AND critical to their understanding. Otherwise,
I reference the glossary tab periodically.
"Remember to review unfamiliar terms in the
glossary before proceeding"

Hope this helps!

Faye Newsham

Sponsored Link

Rates near 39yr lows. $420,000 Loan for $1399/mo.
Calcuate new payment.


WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: paragraph numbering
Previous by Thread: Re: Did MS and Dell have a spat?
Next by Thread: Laptops: travel insurance? Summary.

What this post helpful? Share it with friends and colleagues:

Sponsored Ads