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.
Laura Lemay wrote:
> Re the discussion about how much education to put in a book,
> to quote Andrew Plato:
> >1) The reader does not care about the material, therefore give the reader
> >the bare minimum to get the job done.
> >2) The reader does care about the material, therefore give the reader the
> >complete picture of the situation.
> Either one of these is a valid choice in documenting a product. There
> isn't a right answer that works for every book, at every company, for
> every technology. This isn't the sort of question that's going to be
> answered here.
> However, this is probably the sort of question that should be determined
> by a pubs team as part of a doc plan ...
I think it is worse than that. In most cases, you will have some readers
of each type. Some readers are in both groups, possibly at different times.
I want a quick, simple "getting started" guide when I install your product
and begin to use it, but if I keep using it then I'm going to want complete
documentation sonner or later.
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.