RE: Difference between developer guide content and reference information

Subject: RE: Difference between developer guide content and reference information
From: "Matt Horn" <mhorn -at- macromedia -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 25 Apr 2005 09:55:53 -0400


One way to think of a developer guide is like one of the O'Reilly
cookbooks. There, the authors really illustrate how parts of the system
work together to solve a common problem.

In a reference guide, most of the parts (maybe, classes) are presented
on their own and it's up to the reader to put the ideas together... In
other words, it's best not to "read" a reference guide, but rather to
refer to it. :)

Another thing to think about is that some of the functionality you've
described as being in a developer guide might better be used in a
separate administrator's guide. For example, security and configuration.
Also, server admins often want architectural information as well so they
can see how well the product plays with other products on the system.

Matthew Horn
Sr. Technical Writer
< m a c r o m e d i a >

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

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: RE: Do you spellcheck Code Comments
Next by Author: RE: Start at the very beginning...
Previous by Thread: Re: Difference between developer guide content and reference information
Next by Thread: Re: Difference between developer guide content and reference information


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

Sponsored Ads


Sponsored Ads