TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
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.
