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 [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: OT: Resources for Alert Standards
ANSI 2007 says: DANGER: Indicates a hazardous situation which, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations. WARNING: Indicates a hazardous situation which, if not avoided, could result in death or serious injury. CAUTION: Indicates a hazardous situation which, if not avoided, could result in minor or moderate injury. It may also be used without the safety alert symbol as an alternative to Notice. NOTICE: NOTICE is the preferred signal word to address practices not related to personal injury. The safety alert symbol shall not be used with this signal word. As an alternative to NOTICE the word CAUTION without the safety alert symbol may be used to indicate a message not related to personal injury. On Feb 5, 2008 12:43 PM, Jerilynne Knight [EMAIL PROTECTED] wrote: 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. ___ -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Resources for Alert Standards
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 [EMAIL PROTECTED] -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] 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 [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/dvint%40bea.com Send administrative questions to [EMAIL PROTECTED] 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. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
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.
OT: Resources for Alert Standards
ANSI 2007 says: DANGER: Indicates a hazardous situation which, if not avoided, will result in death or serious injury. This signal word is to be limited to the most extreme situations. WARNING: Indicates a hazardous situation which, if not avoided, could result in death or serious injury. CAUTION: Indicates a hazardous situation which, if not avoided, could result in minor or moderate injury. It may also be used without the safety alert symbol as an alternative to "Notice". NOTICE: "NOTICE" is the preferred signal word to address practices not related to personal injury. The safety alert symbol shall not be used with this signal word. As an alternative to "NOTICE" the word "CAUTION" without the safety alert symbol may be used to indicate a message not related to personal injury. On Feb 5, 2008 12:43 PM, Jerilynne Knight wrote: > 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. > ___ > -- Art Campbell art.campbell at gmail.com "... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl." -- Richard Thompson No disclaimers apply. DoD 358
Resources for Alert Standards
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.
