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.
My employer wants to prepare a developer's guide for a base product of a
suite of middleware products. The argument being offered in favor of
preparing such a document is that the readers would be hard-core developers
who would use the base product to develop software.
But, would not such a document merely be a user guide for an audience that
comprises developers? Can such a document not be merely called a user guide
for developers?
I would like to know your opinions on the following:
* 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?
* What is the focus of a developer's guide?
* What does a developer's guide typically contain?
Tips in this regard would be much appreciated.
Vlad
_________________________________________________________________
The new MSN 8: advanced junk mail protection and 2 months FREE*
http://join.msn.com/?page=features/junkmail
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.