QUERY: Declaration of Conformity in User Documentation

Subject: QUERY: Declaration of Conformity in User Documentation
From: SB <sylvia -dot- braunstein -at- gmail -dot- com>
To: "TECHWR-L Whirlers" <techwr-l -at- lists -dot- techwr-l -dot- com>, COPYEDITING-L -at- listserv -dot- indiana -dot- edu
Date: Sun, 31 Aug 2008 20:06:14 +0300

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.

However, I was told that this was wrong and that we needed to be move it to
the very beginning of the manual, using a formal document with the address
and the signature of the person in charge.

I have looked through various documents and I find that indeed, some do have
a short version at the beginning of the document but without signature, and
some like us have it as part of the declarations and certifications section.
Is this really not correct?

I only saw one single company that actually signed that document and
included it in their documentation. Is this customary and is this actually a
requirement or best practice or is it the company's choice?

Thanks,

Sylvia
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

Previous by Author: Re: Doc management?
Next by Author: RE: Quick career question--go in-house with another company, or stay outsourced with better conditions?
Previous by Thread: Friday files: technical writing really is important!
Next by Thread: Re: QUERY: Declaration of Conformity in User Documentation


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


Sponsored Ads