RE: Example of quality technical writing: coding style

[Chris Borokowski <athloi -at- yahoo -dot- com>]

I think there's two disciplines here. One is
enlightened programming, which isn't as rare as you
might think. And the second is once you're writing
quality code, how to make it accessible to others. The
two overlap but cannot substitute for one another.

--- Andrew Warren <awarren -at- synaptics -dot- com> wrote:

> 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
> mergin to exactly one
> inch, and used British English spelling... Technical
> documents would be
> much easier to read and maintain."


User Interface design blog
http://user-advocacy.blogspot.com/
Code::Design::UI::Consulting
http://www.dionysius.com/


 
____________________________________________________________________________________
Looking for earth-friendly autos? 
Browse Top Cars by "Green Rating" at Yahoo! Autos' Green Center.
http://autos.yahoo.com/green_center/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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. http://www.DocToHelp.com/TechwrlList

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: http://www.helpandmanual.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.