29. Documentation

Customer product documentation forms part of a product and must therefore be defined and cost targets set as part of the overall product cost. The documentation requirements are usually relatively easy to identify at the product definition stage.

In general the product definition should provide guidance concerning the size or amount of documentation acceptable or required by the purchasers of the product. Any specialised binding or printing requirements along with document quality attributes should be identified. Specialised printing processes and printing qualities such as multiple colour copy, graphics or photography should be defined. Each item of documentation identified should have an associated specification of the usage and method of distribution of the documentation along with special packaging and consolidation requirements that may pertain.

The major categories of product documentation are as described below.

Handling, Storage, Transportation and Distribution Instructions

Whilst these instructions are not strictly part of the product they do influence the condition and reliability of the product as delivered to the customer. Particular emphasis should be placed on defining industry norm product handling, storage and transportation methods. The methods to apply to the product should normally follow these norms closely. The instructions should therefore follow as closely as possible existing instructions for other similar products in order to ensure that the investment in handling, storage or transportation equipment or personnel training is minimised.

Unpacking Instructions

These are typically instructions to the unpacker, to ensure no damage is done to the product. The instructions can include a checklist of items that the product packaging should contain, the order and method by which they should be removed from the packaging, instructions for the proper and safe handling of the unpacked product and any instructions concerning any special disposal requirements for packaging materials.

Assembly, Installation and Commissioning Instructions

Assembly, installation and commissioning instructions may be provided with a product or may be independently provided to installation professionals. Installation instructions will typically cover the physical assembly, placement or deployment of the product, the requirements for specialised installation fixings, the provision of services installation procedure and tests, commissioning requirements and test etc. A key decision at the product definition stage is whether professional installation will be required or not. This will provide guidance for technical writers as to the style to adopt for the installation documentation.