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