Re: Doc Design and Conventions

Subject: Re: Doc Design and Conventions
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Sat, 31 Oct 2009 21:06:38 +1100

Robert Lauriston wrote:
> I'd find that more useful as a PDF, so I could search for the command I want.
>
> I regularly encounter documentation that does a pretty good job of
> telling me what I could figure out for myself, if I COULD FIND WHERE
> IN THE MENU SYSTEM THEY BURIED THE DAMN COMMAND.
>

This is one of the things I really hate about
many help systems, noticed mainly in many
Microsoft products. Often they will tell you the
command but not what menu it's on or dialog box
it's in. Drives me crazy.

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

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

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Doc Design and Conventions: From: Chris Despopoulos
Re: Doc Design and Conventions: From: Gene Kim-Eng
Re: Doc Design and Conventions: From: Robert Lauriston

Previous by Author: Re: Click X, or click the X button?
Next by Author: RE: Examples of Minimalist Writing
Previous by Thread: Re: Doc Design and Conventions
Next by Thread: Doc Design and Conventions


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

Sponsored Ads


Sponsored Ads