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.
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 http://mail.yahoo.com
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.
