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.
RE: The more you know, the less you know you know?
Subject:RE: The more you know, the less you know you know? From:"Norcross, Amanda" <Amanda -dot- Norcross -at- kla-tencor -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 14 Dec 2005 11:56:16 -0800
Geoff Hart said:
> triage: define what is essential and must be done if
> nothing else gets done, what should be done if I have
> time remaining, and what I can avoid doing at all (or
> delay to a future release without harming anyone
> much)? That focuses one's efforts most wonderfully.
To which John Posada replied:
<<In effect, that's what I'm doing. The following is an example from
In our tech writing group, when we are in a bind, we cover only the most
important information for a feature. When we document a feature, we know
that we need to create window descriptions, procedures, overviews,
glossary terms, troubleshooting topics, and so on. If we are really in
crunch mode (which seems to be way too much lately) and we don't have
time to create all the documentation for a feature, we'll work with our
SMEs to prioritize the types of documentation required for the feature
(the aforementioned window descriptions, etc.) and then create only the
most important, crucial documentation. It's not ideal and, yes, you have
to return to complete the documentation at some point, but it allows you
to at least provide basic documentation for all features instead of all
the documentation for only some of the features.
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