RE: "Developers Guide", "Developers' Guide", or "Developer's Guide"

[Fred Ridder <docudoc -at- hotmail -dot- com>]

Gordon McLean wrote:> Which prompts me to ponder why the other types aren't titled:
> 
> Using [product name]
> Developing with/on/for ...
> 
> In other words, if an Installation Guide is focussed on the task of
> installing a product, why aren't the others focussed on the tasks of using,
> developing, maintaining, administering... etc.
 
If parallelism is the goal, these titles still have a problem unless you give
the guide that covers installation a title of the form "Installing [product 
name]".  And while I do like using verb participles (sometimes referred to
as gerunds, even though they are usually not being used as nouns) in 
headings that idenitfy procedures, I'm not crazy about them in titles
of works.  
 
But what *can* work in many cases is to form titles with the noun
for the task being documented rather than the person performing the 
task, as in:
  Administration Guide
  Development Guide (or perhaps Application Development Guide)
  Installation Guide 
  Maintenance Guide
The one place where this approach is awkward is the classic one,
namely the user's guide.  But part of the problem may be that this
title is often used for a catch-all document that contains information
on multiple tasks (e.g. installation and configuration as well as how
to use the product, plus some reference information just for good 
measure).  So the problem may be a more fundamental one of
information design than a simple matter of an awkward title. 
 
Fred Ridder 
 
 
_________________________________________________________________
Shed those extra pounds with MSN and The Biggest Loser!
http://biggestloser.msn.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.