how to handle code as appendices

Subject: how to handle code as appendices
From: "Jill Mohan" <jillemo -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 27 Jul 2007 11:02:58 -0400

Hi All -

I am writing an install/config doc for a virtual directory server
implementation.

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

The customer thinks these things should appear as appendices. But I am
looking at a lot of appendices right now and growing daily (about 12).
Should I segment it by type of code, ex. Appendix A - Router config code,
Appendix B: Oracle code, etc.

How have people handled this in the past??

Any light you can shine is much appreciated.

Thanks,
Jill
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

Previous by Author: RE: Tech writers still necessary, but performing poorly
Next by Author: RE: 40-hour weeks (was Re: FWD: Lack...)
Previous by Thread: More ESL Help
Next by Thread: RE: how to handle code as appendices


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


Sponsored Ads