Re: Doc Design and Convention

Subject: Re: Doc Design and Convention
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 3 Nov 2009 08:10:21 -0800 (PST)

This isn't about the quality of the index, it's about the content.

Many times I've found the term I want in the index, and it directs me
to a topic that I've already read, which neglects to tell me the menu
path to the dialog box where you set the multiplex input port number.

Great... Even more reason to leave the task description at a level above
the dialog box, and treat the dialog box like a function in a
programming language. You just add a new heading to your standard page (topic, what-have-you):

* Command (er, Dialog Box Name?)
* Menu path
* Synopsis
* Description
* Inputs
* Outputs
* Warnings


Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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.

Please move off-topic discussions to the Chat list, at:

Previous by Author: Re: TECHWR-L Digest, Vol 48, Issue 27
Next by Author: Re: Doc Design and Convention
Previous by Thread: Re: Doc Design and Convention
Next by Thread: Re: Doc Design and Convention

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

Sponsored Ads