Reference Manual

Subject: Reference Manual
From: vinay -dot- babu -at- philips -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 6 Sep 2001 16:50:26 +0530

Hi! All,

I'm working on a Reference Manual/Integration Document for a software stack. Since this is the first time I'm working on a Reference Manual, I would be happy to get your feedback on both technical and information design aspects of such a document.
* Can anyone direct me to the sources where I can get samples of a reference manual
* What are the essential elements that needs to go into such a document?
* Are there any books that give information on the design aspects of a reference manual?

Working with MS-Word

How to create a table of contents and a cross reference index?
How to insert different headers and footers for different chapters?
How to create a different format for chapter pages without disturbing the overall document design?

Pls enlighten me on this.

Warm regards,

G.P. Vinaybabu









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

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.com http://www.miramo.com +++

---
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.


Follow-Ups:

Previous by Author: RE: Job Market: More Openings for Marcom than Tech-Writing?-Not Here
Next by Author: Photoshop and Graphics Work
Previous by Thread: RE: Customers who read manuals from cover to cover
Next by Thread: cross reference index.


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


Sponsored Ads