Re: For Hardware TWs - a question

Subject: Re: For Hardware TWs - a question
From: randall -dot- larson-maynard -at- powerconv -dot- alstom -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 16 Jan 2001 07:54:52 -0800

Normally I document software but a new project involves revising all docs
for a hardware-based product. In the existing User Guide, near the very
front of the book, there's a page called "Declaration of Conformity". It's a
form, of sorts, filled out and signed by a QA engineer in our company.
My questions: What is this? And is this an appropriate place for it?
Anything that will increase my knowledge about writing for a hardware (with
some software) product would be great.

The form tells the customer that the product has passed in-house QA standards,
just before shipping, as stated on the form. We do not place these in our
manuals. The reason we don't is simple; most of our customers keep the form
filed away in some dusty cabinet with the sales order and warranty. The manual
is used on "the shop floor." Keeping them separate is the only way to keep the
form from being lost. The form is only useful to our customers in warranty
issues and initial set-up issues.

Your customers may have different needs. Some research on your part is in order.
Find out what the customer's needs are involving this form. Make the choice
after you know what the usage is. As I see with most things in tech writing;
know your users and adjust to them.

Randall Larson-Maynard
Technical Writer
Alstom Schilling Robotics
Davis, CA, USA
randall -dot- larson-maynard -at- powerconv -dot- alstom -dot- com

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. or toll-free 877/278-2131.

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.

Previous by Author: Book Recommendations?
Next by Author: Re: New TECHWR-L Poll Question
Previous by Thread: Re: For Hardware TWs - a question
Next by Thread: RE: For Hardware TWs - a question

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

Sponsored Ads

Sponsored Ads