RE: Example of quality technical writing: coding style

Subject: RE: Example of quality technical writing: coding style
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 28 Mar 2007 08:49:14 -0400

You just quoted a developer I know almost word-for-word.

ROFGFO (Rolling on the floor gasping for oxygen),


> -----Original Message-----
> From: Andrew Warren
> Sent: Tuesday, March 27, 2007 6:23 PM
> To: Chris Borokowski; techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Example of quality technical writing: coding style
> ... Saying that these superficial formatting details can
> significantly improve the maintainability of a program is like
> saying "If everyone used the 'Chapter-Page' page-numbering
> method, and labeled list items with letters rather than numbers,
> and set the left margin to exactly one inch, and used British
> English spelling... Technical documents would be much easier to
> read and maintain..."

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output.

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

RE: Example of quality technical writing: coding style: From: Andrew Warren

Previous by Author: FW: Any comments on Word 2007?
Next by Author: The cost of inaccurate technical documentation
Previous by Thread: RE: Example of quality technical writing: coding style
Next by Thread: Re: Getting Black Balled by a Doc Manager & Filing for Unemployment -Need Advic

What this post helpful? Share it with friends and colleagues:

Sponsored Ads