warnings, cautions, notes in sw documentation

[mathieu jacquet]

Hi hessiansx4,

Here is how we define them in our doc:

. Warning mention (+ pictogram): WARNING indicates a potentially hazardous situation which, if not avoided, can result in death or serious injury.

. Caution mention (+ picto): CAUTION indicates a potentially hazardous situation which, if not avoided, can result in minor or moderate injury.

. Caution mention (without picto): CAUTION, used without the safety alert symbol, indicates a potentially hazardous situation which, if not avoided, can result in equipment damage.

We talk about "equipment damage" because our soft is used for remote equipment control.

Mathieu.

> Date: Sun, 31 Jul 2011 20:42:37 -0700
> From: hessiansx4 at yahoo.com
> Subject: warnings, cautions, notes in sw documentation
> To: framers at lists.frameusers.com
> 
> Hello all! I've noticed that the legacy docs I'm currently working on use notes and warnings (no cautions) for a software product. I asked why a warning was used instead of a caution and was told: that's the way we do it here. I've only used warnings when bodily harm could result from some action. How are those of y'all in the sw world doing it? 
> _______________________________________________
> 
> 
> You are currently subscribed to framers as bobitch at hotmail.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/bobitch%40hotmail.com
> 
> Send administrative questions to listadmin at frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
 		 	   		  
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20110801/45e02c2a/attachment.htm>