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'd offer it's really common to combine policy and procedure in the same
document. Certainly it is for our bombs and warheads and I believe it is in
aircraft maintenance as well and I expect most think in such
cases--including hospital procedures--that's the way it should be. The
policy is ... do it this way, use only these materials, etc. But, you can
also use "generic" terms like "suggested," "according to standard practice,"
etc.
Think of policy as "background" if that helps, or that your manual contains
both "what" and "how." I'd take the position that the purpose of the book
is to help get work done (correctly), and I'd structure it around that.
Just begin each task with the related policy. Probably the first chapter or
whatever is the "policy on policy," that is, the statement that this manual
rules. This is a bit the opposite of the more frequently occurring
discussion on this list where the topic is software manuals and the debate
is "are they really needed?"
As for jargon, I'd explore the idea of using both "normal" language and the
jargon too and making it "educational" by relating the two and explaining
it. Just because it's policy, doesn't mean it can't be conversational and
useful (but there may be a "boss" that objects). Since it's important to
avoid misunderstanding, you should do what it takes to ensure the manual is
understandable. I suggest for sure an organized review or testing procedure
involving persons who will actually be using the manual be performed prior
to final issuance of the manual.
Since you're in print, you need a system to track every copy and ensure each
page in every copy is the current version of that page. It might also be a
good idea to set up a "suggestion box" system whereby users can submit
complaints about how something is worded or about an actual "how to" or
"with what" and with published procedures for addressing this input and
either rejecting it or formally changing the manual in response.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
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.
