Hi Simon, I really like your interpretation. I'm also dealing with Software Manuals and wrote Hardware Manuals before, so I'm sort of having the same problem. Are there any official rules (similar to ANSI Z535) for software documentation?
- Maike -----Urspr?ngliche Nachricht----- Von: framers-bounces at lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] Im Auftrag von Simon North Gesendet: Dienstag, 2. August 2011 17:18 An: framers at lists.frameusers.com Betreff: Re: warnings, cautions, notes in sw documentation 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 in an irreversible change to the system (such as deleting a user account) or damage to the hardware Caution: an action that may seriously affect system performance (memory usage), make take an extremely long time (resulting in inability to use the system), may seriously affect the system integrity (like removing password control or disabling a firewall) or loss or changes as listed for a warning that are reversible. Note: an action that may result in inconvenience or confusion or, positively, actions that may make usage easier. Regards, Simon North Technical Writer, Quintiq. _______________________________________________ You are currently subscribed to framers as roeder at squidds.de. 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/roeder%40squidds.de Send administrative questions to listadmin at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
