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.
Subject:? format for notes, cautions, warnings From:Miki Magyar <MDM0857 -at- MCDATA -dot- COM> Date:Wed, 5 Nov 1997 12:46:44 -0700
I'm working on the template/style guide for our user docs, and I'd like your opinion on an effective format for notes, cautions, and warnings. (Note = added useful information; caution = possible damage to equipment or person; warning = danger = serious injury or death, or serious failure.) We will be using an indented page layout with level 1 and 2 headings on the left margin.
I've seen a number of different ways to call attention to these notes, but none that really make me happy. I would appreciate any samples you can send me. I think fax is better than email for this case, but you could try a verbal description. Please respond offline, and I'll post a summary to the list if there's enough interest.
TIA -
Miki Magyar
mikim -at- mcdata -dot- com
fax: (303) 465-4996
