RE: how to handle code as appendices

["Mark the Writer" <mdb-career -at- cox -dot- net>]

***

The challenge I am facing is how to handle the code snippets that I have
been supplied.

***

I am an EE that writes docs and sw and I recommend that if you have for 
instance a chapter that describes Router config code - then you just add 
a head for "Router config code example."

Jumping back and forth between the covers really knocks usability.

Engineers always complain to me about writers not taking document usability
into account.

The say writers just use the "it is in there somewhere" approach. 

Mark
mdbinc.com




-- 
No virus found in this outgoing message.
Checked by AVG. 
Version: 7.5.476 / Virus Database: 269.10.20/919 - Release Date: 7/26/2007 9:56 AM

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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/ for more resources and info.