Fatal and unused - full text

["Jane Carnall" <jane -dot- carnall -at- digitalbridges -dot- com>]

There are five types of log file on the platform that we supply to outside
developers. The fifth type is "Fatal".

The note the SME provided for it said:

FATAL - used for very serious problems that may cause the whole system to
fall over (please don't write any code which needs this log).

I rewrote:

Fatal is used to log very serious problems that can cause the whole system
to crash. We have not provided an example because we don't actually want you
to ever need to use this log, or worse yet, cause us to need to use it.

(All of the other log type descriptions are provided with an example.)

I'm not sure the second sentence is necessary, but I liked it. It seems odd
but it's certainly logical to tell outside developers that we don't want
them find themselves using this type of log but that it does exist. Input?

Jane Carnall
Technical Writer, Digital Bridges, Scotland
Unless stated otherwise, these opinions are mine, and mine alone. Apologies
for the long additional sig: it is added automatically and outwith my
control.

PS apologies for earlier truncated version: accidentally hit the send key
too soon.





________________________________________________________________________

E-mail is an informal method of communication and may be subject to data corruption, interception and unauthorised amendment for which Digital Bridges Ltd will accept no liability. Therefore, it will normally be inappropriate to rely on information contained on e-mail without obtaining written confirmation.

This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden.

________________________________________________________________________


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.