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.
MOST of the manuals for Windows-based software I have
seen of late start off by stating something akin to:
''A basic understanding of Microsoft Windows and Windows
terminology is required to successfully install and
operate our most excellent program, Dude.''
Knowledge of required COMMON peripheral hardware and
software normally should be /beyond the scope of this
manual./ Where the program interacts with the peripheral
may very well be /within scope/ and should be included in
the manual.
When writing to a /mixed/ audience of novices and
(semi-)experts, consider (if allowed) a formatting /trick/
that has worked for me.
<head>Subject head (Install O-ring)
<leed>Install a new O-ring as follows:
a. shut off flow and tag all controls as OFF
b. open housing
c. replace O-ring
d. close and secure housing
e. turn on flow and remove OFF tags
<secondary>Perform the following procedures to
replace the <descriptive> O-ring.
a. shut off flow (etc)
b. use a <size> wrench and turn the 10
<size> nuts counterclockwise (ccw) ...
c. lift off the upper housing.
d. remove the diaphragm plate, diaphragm, ...
e. remove <descriptive> O-ring.
f. lubricate new <descriptive> O-ring ...
and so on (I'm boring myself)
Bottom line: you are presenting a /check list/ for the
(semi-)expert and step-by-step detailed instructions
for the novice.
I wish I could claim this was my idea ... it is not. IBM/Denver
some time back did something similar with html ... an Air Force
E-3 (novice level) logs on to a laptop and receives detailed
procedural instructions for a task; an E-9 (expert) logs on and
receives a check-list to perform the same task.
BTW, the novice E-3 may have a PhD, but REGARDING THE SPECIFIC
TASK, the E-9 with a GED has a HIGHER task-specific
comprehension. ('Course the E-9 may have been the E-3's PhD
advisor ... with /weekend warriors/ you never know.)
( Fathers - your daughters are safe ...
the Air National Guard is in the air. )
______________________________________________________
Get Your Private, Free Email at http://www.hotmail.com
