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.
"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:
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 http://mail.yahoo.com
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! http://www.webworks.com/techwr-l