warnings, cautions, notes in sw documentation

[David Farbey]

Hi,

The general convention (which is based on an ISO standard whose number I
can't recall offhand) is that a "Warning" indicates the danger of death or
injury to people; a "Caution" indicates some lesser risk, such as a loss of
data; and a "Note" indicates some additional parenthetical or interesting
information.

Many companies don't see the need to apply any external standards to their
software documentation so, in the real world, "that's the way we do it here"
trumps all other standards, ISO or otherwise.

David

On 1 August 2011 04:42, hessiansx4 <hessiansx4 at yahoo.com> wrote:

> 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 dfarbey at yahoo.co.uk.
>
> 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/dfarbey%40yahoo.co.uk
>
> Send administrative questions to listadmin at frameusers.com. Visit
> http://www.frameusers.com/ for more resources and info.
>



-- 
David Farbey - david at farbey.co.uk
Mobile  07879 005 946
Web site/Blog <http://www.farbey.co.uk>
Twitter <http://twitter.com/dfarb>
LinkedIn <http://www.linkedin.com/in/informationdesign>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20110801/d09ec361/attachment.htm>