Re: Doc Design and Convention

Subject: Re: Doc Design and Convention
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 2 Nov 2009 19:51:08 -0500

On Mon, Nov 2, 2009 at 11:43 AM, Robert Lauriston <robert -at- lauriston -dot- com> wrote:
> 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.

I'm currently trying to clean up this sort of problem at my current
gig. Many of their procedures (which I didn't write but inherted)
start with "In the framazan screen, do X." But the procedure doesn't
tell you how to get to the framazan screen if you're not already
there. Which isn't very helpful if you got to the procedure via the
TOC or index instead of reading the entire documentation.

Are you looking for one documentation tool that does it all?&#160; 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:

Re: Doc Design and Convention: From: Chris Despopoulos
Re: Doc Design and Convention: From: Robert Lauriston

Previous by Author: Writing for the U.S. military: Getting started
Next by Author: Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)
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