RE: writing quality

["Steve Hudson" <steve -at- wright -dot- com -dot- au>]

a) define the product life cycle, for us its design, development, testing,
production, maintenance

b) ensure there is at least one feedback step. We use feedback at all
levels. Once in production it freezes unless the maintenance cycle dictates
otherwise.

c) mandatory reviewers include representatives from the identified user
groups, the product manager for product doco, team leaders for team doco, at
least one formal editor's review and an SME.

d) each document must be tested for completeness AND accuracy. We use a
variety of methods to test completeness - tech specs module descriptions,
user interface exploratory runs as well as expert user opinion.



-----Original Message-----
From: bounce-techwr-l-62124 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-62124 -at- lists -dot- raycomm -dot- com]On Behalf Of
train2 -at- sprynet -dot- com
Sent: Wednesday, 14 March 2001 04:14
To: TECHWR-L
Subject: writing quality


So...how do we know what we write is useful and readable?
Are there methods for checking? Who tests the documentation?
Looking for a little feedback here.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15.  http://ieeepcs.org/2001/

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