Re: complete documentation

Subject: Re: complete documentation
From: Tony Markos <ajmarkos -at- yahoo -dot- com>
To: Tracy Taylor <ipsque -at- yahoo -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 12 Jan 2006 13:36:44 -0800 (PST)

Tracy Talor asks:

"What is complete and accurate documentation to you?"

Tony Markos responds:


* The system itself has been properly scoped (i.e.,
its extent determined)and verified with the customer.

* The documentation about the system has been properly
scoped (i.e., the docs and sections contained within
each doc has been determined) and verified with the

* The functionality within the defined scope of the
system has been properly partitioned into approx
equal-size and right-size "chucks" (Rule of thumb:
Each functional chunk can be described on about a page
or so of text).

* The documentation for each above "chunk" has been
verified with SME(s).

--- Tracy Taylor <ipsque -at- yahoo -dot- com> wrote:

Hi -

We are lucky in that we get some feedback on our
documentation from customers, but I'm not always sure
how to address the feedback.

For example, we get feedback that we need "complete
documentation." In your mind, what does that mean?

Cover every feature in "sufficient" depth? We also
get complaints that people can't find information.

Accuracy I understand better, but again, it's hard to
address how to be more accurate.

What is complete and accurate documentation to you?

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

complete documentation: From: Tracy Taylor

Previous by Author: Re: Are your documents interesting?
Next by Author: Re: The non-learning organization?
Previous by Thread: Re: complete documentation
Next by Thread: RE: complete documentation

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

Sponsored Ads