Re: Contents, Focus of Developer's Guide

Subject: Re: Contents, Focus of Developer's Guide
From: "Michael Collier" <mcollier -at- maryland -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 4 Nov 2003 07:02:04 -0700


I'd call it a developer's guide...<sarcasm>developers are never mere users, you
know.</sarcasm>

You would want to include a discussion of the layers of the existing
middleware, with examples of how existing functions and services interact
with it. Illustrations are important--get going on a system architecture
diagram, or find one you can use or modify.

A class dictionary is pretty important...what are the key classes of the
existing middleware that new functions and services need to interact with,
and how do new functions communicate with existing functions and classes.

> If a user guide for developers should be called a developer's guide, > then, in what way would the developer's guide differ from other user > guides?

It still has to be thorough and utterly clear and accurate...you're
dealing with a pretty critical audience. One way it could be different is
that you can err on the side of too much information, as long as the
information is indexed, cross-referenced and easy to find.

Michael Collier
mcollier -at- maryland -dot- com

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

ROBOHELP FOR FRAMEMAKER TRIAL NOW AVAILABLE!

RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4

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



Previous by Author: Re: Offshore writers and editors
Next by Author: Anyone use Packword?
Previous by Thread: Contents, Focus of Developer's Guide
Next by Thread: RE: Contents, Focus of Developer's Guide


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


Sponsored Ads