Re: Jargon Lovin' Fool

Subject: Re: Jargon Lovin' Fool
From: Sandy Harris <sandy -at- storm -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 22 Oct 2001 16:33:54 -0400

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

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 for more resources and info.

Re: Jargon Lovin' Fool: From: Andrew Plato
Re: Jargon Lovin' Fool: From: Laura Lemay

Previous by Author: Re: Jargon Lovin' Fool
Next by Author: Re: PDFs on Unix
Previous by Thread: Re: Jargon Lovin' Fool
Next by Thread: Re: Jargon Lovin' Fool

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

Sponsored Ads