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 ...<snip> ... 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?
+++
Why would "User Guide for Developers" be clearer than "Developer's Guide"???
People will be arguing that "end-user" is redundant next :-)
If you're writing for developers, then you should:
* call the guide for developers something obvious like "developer's guide"
otherwise they will not notice it
* call any end-user information you provide for those developers to pass on
to their users something like "end-user information"
If on the other hand you're writing for end-users, then you should:
* call the end-user guide something like "user guide"
These simple rules could avoid developers;
a) not noticing that you did some docs aimed at them
b) hitting you round the face with a wet fish
c) forcing you to watch Tron until you agree you understand
the difference between a programmer and a user
Christopher Gooch, Technical Author
LightWork Design, Sheffield, UK.
www.lightworkdesign.com
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.
