Resources for Alert Standards

Dan Vint dvint at bea.com
Tue Feb 5 09:51:52 PST 2008


In milspec writing for mechanical repair information there is a
hierarchy to the warnings cautions and notes. I believe with that order
its like "may cause bodily harm" = warnings, "may cause harm to the
machine" = cautions, and notes are just additional information or
clarification. There are no tips in this arena.

With software docs, I don't think you need as many levels unless you are
dealing with control software. So your typical application like word, a
caution or warning might be used if you are deleting a file or making a
major system change that might be difficult to revert. While a note is
informational and tips seem to be the super user or guru level of
information.

..dan

***************
Dan Vint
Engineer Sr.
BEA Systems

Home: 510-522-4703 (generally working from home)
Office: 408-570-8554
IM Yahoo: dvint1_99

dvint at bea.com 
 

> -----Original Message-----
> From: framers-bounces at lists.frameusers.com 
> [mailto:framers-bounces at lists.frameusers.com] On Behalf Of 
> Jerilynne Knight
> Sent: Tuesday, February 05, 2008 9:44 AM
> To: Framer's List
> Subject: OT: Resources for Alert Standards
> 
> Hi all
> 
> I'm looking for standards on the proper use of terms like "Notes",
> "Cautions", "Warnings", "Tips", etc. in software documentation. When I
> search, I'm finding ANSI and IEEE standards that are 
> available for purchase.
> At this point, I don't really want to purchase the entire 
> standard. I simply
> want to know the proper convention for using these terms. I 
> *know* I had
> this information at one time and can't seem to find it in my files!
> 
> Anyone have any documentation or recommendations?
> 
> Thanks in advance for your help.
> 
> Sincerely
> 
> Jerilynne
> Simpy Written, Inc.
> _______________________________________________
> 
> 
> You are currently subscribed to Framers as dvint at bea.com.
> 
> Send list messages to framers at lists.frameusers.com.
> 
> To unsubscribe send a blank email to 
> framers-unsubscribe at lists.frameusers.com
> or visit 
> http://lists.frameusers.com/mailman/options/framers/dvint%40bea.com
> 
> Send administrative questions to listadmin at frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
> 

Notice:  This email message, together with any attachments, may contain information  of  BEA Systems,  Inc.,  its subsidiaries  and  affiliated entities,  that may be confidential,  proprietary,  copyrighted  and/or legally privileged, and is intended solely for the use of the individual or entity named in this message. If you are not the intended recipient, and have received this message in error, please immediately return this by email and then delete it.



More information about the framers mailing list