Re: QUERY: Declaration of Conformity in User Documentation

Subject: Re: QUERY: Declaration of Conformity in User Documentation
From: Peter Neilson <neilson -at- windstream -dot- net>
To: SB <sylvia -dot- braunstein -at- gmail -dot- com>
Date: Sun, 31 Aug 2008 22:22:47 -0400

SB wrote:
> In our User Documentation, as part of the declarations and certifications
> section, our declaration of conformity is a sentence saying that we comply
> to the required standards.
> (etc)

As a side issue, these certifications are generally set forth as part of
a "quality" effort, but actually have little or nothing to do with
quality. Instead they claim (but not not ensure) conformance to a
standard that could even *decrease* the level of quality of
documentation, for instance by requiring the material to be presented
badly. The ambiguity of location for the declaration might stem directly
from bad standards.

My wife the quality engineer says that yes, I am correct in my
understanding of this weird issue.

I wonder if people who design these standards (to which stuff is
supposed to conform) ever actually test the standards themselves, as
opposed to testing conformation to them? I'm thinking especially of
standards that do not scale well, so that a test on a minuscule document
(or perhaps on a pilot plant) looks ok, but on the full document set (or
the huge factory) the standards are invasively destructive.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
QUERY: Declaration of Conformity in User Documentation: From: SB

Previous by Author: Re: Advice for someone re-entering the work force
Next by Author: RE: Suggestions for numbering in Word
Previous by Thread: Re: QUERY: Declaration of Conformity in User Documentation


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


Sponsored Ads