[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Documentation structure

Subject: Re: Documentation structure
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 6 Feb 2005 08:25:32 -0800


"Getting Started" as a separate document is useful when the fill UG is
very large, as there is often a tendency for many users to be deterred
from opening a large manual. You plan this document around the steps
required for the user to prep systems and/or facilities for your product,
install the product and verify that it is functioning correctly, or if these
subjects are covered in an installation manual, around the steps required
to educate the user on the initial introduction to the operating principles and most basic functional steps that will probably not be referred to on
a regular basis.

From a Marketing standpoint, a "comprehensive range" of documentation
may seem more impressive than a single document, but in most cases, the primary reason behind the decision to extract functions such as trouble-
shooting, applications, etc., from a single UG is to cut down on UG size and help overcome the "intimidation factor" of a huge manual.
Gene Kim-Eng



Troubleshooting
----- Original Message ----- From: "Caroline Tabach" <Caroline -at- radcom -dot- com>

The company would really like to give the users "impressive" documentation!




--
No virus found in this outgoing message.
Checked by AVG Anti-Virus.
Version: 7.0.300 / Virus Database: 265.8.5 - Release Date: 2/3/2005


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

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

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.

---
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:
Documentation structure: From: Caroline Tabach

Previous by Author: Re: giving feedback to non writers
Next by Author: Re: New TECHWR-L Poll Question - Degrees
Previous by Thread: Re: Documentation structure
Next by Thread: RE: Documentation structure

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads