Re: Why is it important to reorganize the help files

Subject: Re: Why is it important to reorganize the help files
From: Writers Book Mall <steve -at- writersbookmall -dot- com>
To: Zen C <zenizenc -at- yahoo -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 1 Aug 2007 06:18:25 -0700 (PDT)

Since you're at a software company, the explanation is
pretty simple: explain that instead of hard-coding the
information in multiple locations, making it confusing
for the reader and hard to maintain, you propose
organizing just like you would a software program,
with the introductory definitions occuring once at the
beginning so that subsequent sections can refer to

--- Zen C <zenizenc -at- yahoo -dot- com> wrote:
> The company I work for has a software with 5 modules
> and some functions can be done in 3 different ways
> using different modules. I am taking over the help
> files and have been asked to clean the mess, but
> need to give valid reasons for my suggestions.
> Information in these modules are all repeated
> including explanations of controls ( e.g what a
> dialog box is) everywhere in the document.
> Can anyone please give some good points I can give
> as reasons for the change.

Finally, a web host who will help you build and run a site: The Hosting Team -
Books for writers at
Tech writing jobs at

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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: Checking for updated documentation
Next by Author: The age-old markup question, with a twist
Previous by Thread: TECHWR-L Premium Jobs, Events, and Announcements
Next by Thread: RE: icons vs. buttons?

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

Sponsored Ads