[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: doc'ing the docs

Subject: Re: doc'ing the docs
From: Gordon Meyer <gordonmeyer -at- mac -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 4 Dec 2002 14:12:12 -0800


Sure, we can all imagine situations where "help on help" might be useful, but here's an actual example. (Product name obscured to avoid accidentally embarrassing someone.) As they say, the proof is in the pudding, and there's nothing here that either already hasn't been discovered by the user (because they've navigated to this page) or isn't completely obvious. For example, it contains the shocking revelation that the the index is in alphabetical order and contains links (which are blue and underlined) to associated topics.

Thanks for the hypothetical examples of where such doc is useful and could have a significant impact, but I'm still hoping to find a real-world case. Hope spring eternal.

--Gordon



Using this help system
You can get step-by-step instructions for specific tasks in this onscreen help system.

To access [prodcut name] Help:

• Choose [product name] Help from the Help menu.

Note: Choosing Help opens the Help application. When you're not using Help, you can close it.

Moving around in [pn] Help

You move around in [pn] Help by following links, which are identified by underlined text. To follow a link:

• Click once anywhere in the underlined text.

There are several navigational aids in [pn] Help:

• You can search for a term in help by typing your query and clicking Search.
• The table of contents lists main topics on the left. When you click a main topic, you see a list of subtopics on the right.
• The index contains an alphabetical list of concepts with links to associated help topics.
• Links to the table of contents and index appear at the bottom of every page.
• A list of related topics appears at the end of many pages.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

---
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
http://www.raycomm.com/techwhirl/ for more resources and info.

References:
Re: doc'ing the docs: From: Gordon Meyer

Previous by Author: Re: doc'ing the docs
Next by Author: Re: TOC article in INTERCOM -- things that made me go "HUH??"
Previous by Thread: Re: doc'ing the docs
Next by Thread: RE: doc'ing the docs

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads