Re: Starting a new project

Subject: Re: Starting a new project
From: "Dick Margulis" <margulis -at- mail -dot- fiam -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 14 Feb 2001 12:01:17 -0500


You could begin the unified manual with a short How this Manual is Organized preface. In it you could include a diagram that shows users how to navigate the manual, depending on where they want to end up.

Within the body of the manual, you can simply refer people to the relevant chapter for each function, rather than repeat the chapter.

I think that for now it makes sense to organize the chapters into two sections, according to which application the functions reside in, but with a view toward eventually integrating the chapters into one continuous section when the applications are fully integrated.


Jason Logue wrote:

>I'm getting ready to start work on a new manual that will combine
>information from two manuals. The one manual will be for two software
>packages that are slowly being integrated into one fully integrated software
>package. The problem, at least for documentation purposes, is that both
>packages have the same main menu screen, log on screen and a few others, but
>after a point they are completely different packages. However, they have
>integration buttons and menu features that enable the user to jump back and
>forth between software packages.

>My question and/or concern is concerning whether I should split the manual
>in half or not. Some chapters are going to be redundant if I do that,
>though. If anyone has any design plans, flow charts, or general
>suggestions, I'd appreciate the assistance. If you need more detail
>concerning my project, let me know.

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See for more information and free evaluation downloads

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: software life cycle
Next by Author: Re: use of "per"
Previous by Thread: Starting a new project
Next by Thread: RE: Starting a new project

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

Sponsored Ads