Re: Difference between developer guide content and reference information

Subject: Re: Difference between developer guide content and reference information
From: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 25 Apr 2005 08:13:31 -0700


Amen to what Bill and Jeffrey said. Also, reference guides tend to be structured encyclopedically -- for a Java API Reference, you have an alphabetical list of packages; within each package, an alphabetical list of classes/interfaces; within each class/interface, alphabetical lists of fields, methods, etc.

User Guides are task-oriented, with their sequence based on the set of tasks.

--Guy K. Haas
Software Exegete in Silicon Valley

Jeffrey Osier-Mixon wrote:


What Bill said fits my interpretation as well.

Conceptually it sometimes helps to find out what questions the document is supposed to answer. A reference guide, API guide, or other specific reference document answers "what". A developer guide, programmer's guide, etc. answers "how".




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

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.



References:
Re: Difference between developer guide content and reference information: From: Bill Swallow
Re: Difference between developer guide content and reference information: From: Jeffrey Osier-Mixon

Previous by Author: Re: Do you spellcheck Code Comments
Next by Author: Re: How do you maintain dynamic material
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