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.
Note: parenthetical information, placed immediately after the paragraph
containing the referencing information:
NOTE (bold, caps, centered)
Text of note greeking greeking greeking greeking
(normal weight, initial caps, indented L and R)
Caution: information concerning possible harm to product or equipment,
placed immediately _before_ the paragraph containing the referencing
information:
CAUTION (bold, caps, centered)
Text of caution greeking greeking greeking greeking
(bold, initial caps, indented L and R)
Warning: information concerning possible harm to personnel, placed
immediately _before_ the paragraph containing the referencing information:
______________
WARNING
______________
Text of warning greeking greeking greeking greeking
(bold, initial caps, indented L and R)
************
Exact formatting details can vary according to a company's writing style
guide. The definition and formatting of each should be specified in the
company's writing style guide. The company should _have_ a writing style
guide.
Source: Government Printing Office Style Manual
My cousin, who was a junior officer on the Enterprise aircraft carrier, told
me that all three used to be placed after the referencing information. This
was changed after the Navy lost several junior officer electricians because
the "DANGER! High voltage hazard in the next step" warning appeared on the
next (back) page of the manual, after the "remove screws from interior panel
attachment plate" instruction. John had a warped sense of humor so I'm not
sure that this is true, but it certainly helped me to remember to always
place my personnel hazard warnings before the hazard-containing procedural
step.
Dori Green
Technical Writer, QMS Project
Associated Brands, Inc.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-