TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
In our online help systems, document design conventions require that
each topic includes the navigation path to the option within the
software (so users can find it). For example, under the title for the
XYZ report, the topic includes this path: Reports > Absences > XYZ
If users land on the topic via TOC, index, or search, the path to the
report screen is evident. We no longer get support calls just to find
out where an option is located. Applications' pdf training materials
follow a similar convention (although formatting is for hard copy rather
than online viewing).
From: Julie Stickler [mailto:jstickler -at- gmail -dot- com]
Sent: Monday, November 02, 2009 7:51 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Doc Design and Convention
On Mon, Nov 2, 2009 at 11:43 AM, Robert Lauriston <robert -at- lauriston -dot- com>
> 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.
This message may contain privileged, confidential information that is
exempt from disclosure under applicable law. If you are not the addressee
indicated in this message or if it does not apply to you or your
organization, you may not copy or deliver this message to anyone. In such a
case, please delete this message and reply to the sender immediately. Thank
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: 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-