Re: warnings, cautions, notes in sw documentation

2011-08-03 Thread 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

RE: warnings, cautions, notes in sw documentation

2011-08-03 Thread Brian Emrich
08:28 AM To hessian...@yahoo.com, framers@lists.frameusers.com, mathieu jacquet bobi...@hotmail.com cc Subject RE: warnings, cautions, notes in sw documentation The use of Warnings, Cautions, and Notes, specifically Warnings and Cautions, are used differently in different technologies

Re: warnings, cautions, notes in sw documentation

2011-08-03 Thread Simon North
All the answers I have seen so far seem to relate to HARDWARE. In a SOFTWARE context, I think it's much more common to use something like the following (this is my wording, so no official): Warning: an irrecoverable action (formatting a disk), permanent data loss or other action that may result

Re: warnings, cautions, notes in sw documentation

2011-08-02 Thread Stuart Rogers
On 31/07/2011 11:42 PM, hessiansx4 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

Re: warnings, cautions, notes in sw documentation

2011-08-02 Thread Milan Davidović
On Sun, Jul 31, 2011 at 11:42 PM, hessiansx4 hessian...@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. Can you share what sort of product it is? -- Milan Davidović http://twitter.com/altmilan

RE: warnings, cautions, notes in sw documentation

2011-08-02 Thread Alison Craig
...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of David Spreadbury Sent: August 1, 2011 5:18 AM To: hessian...@yahoo.com; framers@lists.frameusers.com; mathieu jacquet Subject: RE: warnings, cautions, notes in sw documentation The use of Warnings, Cautions, and Notes

RE: warnings, cautions, notes in sw documentation

2011-08-01 Thread 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

RE: warnings, cautions, notes in sw documentation

2011-08-01 Thread David Spreadbury
, mathieu jacquet bobi...@hotmail.com wrote: From: mathieu jacquet bobi...@hotmail.com Subject: RE: warnings, cautions, notes in sw documentation To: hessian...@yahoo.com, framers@lists.frameusers.com Date: Monday, August 1, 2011, 5:33 AM Hi hessiansx4, Here is how we define them in our doc