Re: "They don't need no stinkin' documentation..."

Subject: Re: "They don't need no stinkin' documentation..."
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 30 Oct 2001 13:20:25 -0800

Sandy Harris wrote:

However, given that, I think you're looking at three essentials for what
you actually put in the docs -- technical accuracy, suitability for the
audience and decent organisation. Miss any of the three and you've blown it, usually fatally.

This may just be a matter of parsing the process differently, but I'd suggest that successful documentation depends on:

- gathering accurate and appropriate information.
- understanding the audience's needs and the circumstances of use.
- organizing the project.
- organizing the information.
- designing the template.
- writing the document.
- reviewing and editing.
- producing the final document (whether steering it through the print house or preparing it for on-line use).

A major failure at any one of these stages can wreck the document.

--
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com

"What will I say when my children ask me,
'Where were you flying on that day?'
With trembling voice, I gave the order
To the bombardier of Enola Gay."
-Utah Phillips, "Enola Gay"




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.


References:
Re: "They don't need no stinkin' documentation...": From: Andrew Plato
Re: "They don't need no stinkin' documentation...": From: Sandy Harris

Previous by Author: Re: Need help please
Next by Author: Re: Technical Writing Union
Previous by Thread: Re: "They don't need no stinkin' documentation..."
Next by Thread: RE: "They don't need no stinkin' documentation..."


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

Sponsored Ads


Sponsored Ads