Re: Why is it important to reorganize the help files

[Writers Book Mall <steve -at- writersbookmall -dot- com>]

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
them.

--- 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 - http://www.thehostingteam.com
Books for writers at http://www.writersbookmall.com
Tech writing jobs at http://www.techwritingjobs.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.