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.
Subject:Re: For Hardware TWs - a question From:"Elliott C. Evans" <eeyore+ -at- cmu -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 16 Jan 2001 11:07:52 -0500
Joanne Meehl wrote:
> 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.
I have never encountered such a form before, but here's my guess:
Where I work, every piece of hardware that leaves the door is inspected to
make sure that it was built according to specification, and that it tests
to within certain tolerances. Your QA engineers have probably decided that
the manuals should be held to similar standards.
The front of the book is a fine place for this. All of my documents here
have to go through an approval proccess, and the modification history with
approval chops is before the table of contents.
--
Elliott C. "Eeyore" Evans eeyore+ -at- cmu -dot- edu
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com 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 http://www.raycomm.com/techwhirl/ for more resources and info.
