“…but can you prove it?” [technical documentation]

Technical writers are called upon for many different types of documentation for any given product. Those documents can be user´s manuals, technical manuals, or marketing brochures, pamphlets and other publications. Most of the background required to write such documents can be, and is, taught in typical college classes. Errors in user´s manuals and technical manuals most often are no more serious than being a cause of frustration on the part of the users. Errors can, however, be the basis of lawsuits on the behalf of the users. In marketing publications there must be serious consideration of a topic known as “proof of claims”. If the publication states that a particular device will work at such and such speeds, then this statement must be substantiated somewhere. Systems must be tested and claims validated. Test plans and test procedures are poorly understood by many technical writers, and the need for good plans and procedures is critical in industry. This paper develops the definition of good test plans, test procedures, data collection and the legal aspects of what is said about a new product versus what can be proven through product testing