Re: Difference between developer guide content and reference information

Subject: Re: Difference between developer guide content and reference information
From: "Mike O." <obie1121 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 25 Apr 2005 07:02:32 -0700 (PDT)

Rachna wrote:
> I have to create a developer guide and a product reference
> (guide?) for the same product. These documents will enable
> developers to create applications based on the product.
> However, I am unclear about the type of content that should
> be included in each guide.

Just wondering - if you don't know what should be in these documents,
how are you so sure you need them?

If your boss/client said you need them, try asking for more detailed
requirements, or examples of previous documents. Perhaps it's time to
step back, take a look at the audience, and identify their information
needs on a fairly detailed level.

In the meantime, why not just start writing the topics you know you
need, then ask your boss to split them up later into whatever books
they want them in?

Mike O.

Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

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 for more resources and info.

Previous by Author: Re: Why should I be worried about the merger? NOT
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: ADMIN More TECHWR-L/STC details

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

Sponsored Ads