Re: Doc Design and Conventions

Subject: Re: Doc Design and Conventions
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 30 Oct 2009 08:35:26 -0700

The last software user documentation I did was a menu tree on a plastic-coated
card that listed the parameters on the dialogs each dropdown opened, plus all
the "bubble help" blurbs the programmers inserted into the program. The API doc
was probably 50X the size of the user docs.

Gene Kim-Eng

----- Original Message -----
From: "Chris Despopoulos" <despopoulos_chriss -at- yahoo -dot- com>
> If that's true, why not just provide an index of controls? Or to be less
> flip, is it time for to ship reference guides again?


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:


Doc Design and Conventions: From: Chris Despopoulos

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

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

Sponsored Ads