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.
I have used angle brackets as described by Kathleen. The task was to create
a user guide for complex maintenance management software (MAXIMO) for
extreme neophytes. In facts, many were computer-phobic. It was a union shop,
and the general attitude was, "I've been doing my job for 30 years without a
computer or maintenance management software, I don't see why I need either
now. Further, it's an extra task and if I can find ANY reason not to use
this software, I'll take it."
A great reason would be hard-to-follow documentation. [Keep in mind these
guys were working on multi-million-dollar equipment, the failure of which
could easily lead to loss of life. In fact, this weekend, they had an
accident due to equipment failure that nearly killed dozens and will
certainly cost the company millions to recompense victims.]
The solution was to create two user guides. One was for neophytes that
explained step-by-step, with screen shots. The other was the angle bracket
method for the more advanced users. The advanced instructions preceded the
basic, so users could see both (until they turned the page to get to Step 2
of the basic instructions). Most people who used the basic manual graduated
to the advanced manual almost immediately. They only had to go through ONE
procedure ONCE at the basic level, then they figured out that the angle
bracket method was much quicker and easier to follow. The basic manuals were
soon gathering dust, replaced by small, laminated booklet containing only
the advanced instructions. That is, it "became intuitive" quickly.
All the best,
Brian
Geoff,
So would it be a fair summary to say that you're saying angle brackets
are ok only when writing for the experienced user?
So I think I might agree that they are best used for instructions aimed
at experienced users. OTOH, when writing a manual, the angle brackets
could be introduced along with more formal instructions for the most
basic actions, which it could be assumed that novices would be using. So
the novice would gradually learn their meaning.
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
