A New Product - Manuals & Documentation
General Documentation
As control modules produced by Alian Electronics are often only a part of a larger product being put together by a company, the documents provided may not reflect the entire product.
Control products developed by Alian Electronics are accompanied with descriptive notes about its operation. Where relevant, test results, circuit diagrams and wiring diagrams will also be provided.
The descriptions of operation on any controls are provided as an MS Word document with plain jargon-free wording so that it may be imported and incorporated as a chapter within a user guide being prepared for the entire product.
Comprehensive Manuals
On occasion Alian Elect has been asked to produce a comprehensive manual for a product as an extension of the design services. The scope of this would depend upon the nature of the equipment, but it may include three separate manuals. An Instruction manual, an Installation manual and a Support manual.
An Instruction Manual is kept simple. It is a description of what the end user/operator needs to know about how to make the product go. It avoids complex technical jargon and it may include a page on warranty terms and conditions.
An Installation Manual has less operator information, but will be useful to an installing electrician where recommendations about cable sizes and circuit breaker ratings may be relevant. It may contain information on unpacking the product and precautions to take where the product is being returned to a supplier for service. It can be a mistake putting material in an installation guide that is not strictly essential to the installation process. The thicker this manual is, the less likely it is that an installing tradesperson will read it!
A Support Manual contains everything relevant to a product that a distributor would want to know. Normally it would be labelled 'Ín Confidence - Not for distribution' It contains all the Operator and Installer notes, plus additional troubleshooting & testing notes. It would not contain detailed circuit board info or other essential detail that would help a renegade manufacturer copy the product. This document would not normally be provided to the operator or general installer, but where a distributor is acting as the first point-of-contact for an end-user, it would be appropriate for them to have access to this more comprehensive product information.
Click here to return to CREATING A NEW PRODUCT
General Documentation
As control modules produced by Alian Electronics are often only a part of a larger product being put together by a company, the documents provided may not reflect the entire product.
Control products developed by Alian Electronics are accompanied with descriptive notes about its operation. Where relevant, test results, circuit diagrams and wiring diagrams will also be provided.
The descriptions of operation on any controls are provided as an MS Word document with plain jargon-free wording so that it may be imported and incorporated as a chapter within a user guide being prepared for the entire product.
Comprehensive Manuals
On occasion Alian Elect has been asked to produce a comprehensive manual for a product as an extension of the design services. The scope of this would depend upon the nature of the equipment, but it may include three separate manuals. An Instruction manual, an Installation manual and a Support manual.
An Instruction Manual is kept simple. It is a description of what the end user/operator needs to know about how to make the product go. It avoids complex technical jargon and it may include a page on warranty terms and conditions.
An Installation Manual has less operator information, but will be useful to an installing electrician where recommendations about cable sizes and circuit breaker ratings may be relevant. It may contain information on unpacking the product and precautions to take where the product is being returned to a supplier for service. It can be a mistake putting material in an installation guide that is not strictly essential to the installation process. The thicker this manual is, the less likely it is that an installing tradesperson will read it!
A Support Manual contains everything relevant to a product that a distributor would want to know. Normally it would be labelled 'Ín Confidence - Not for distribution' It contains all the Operator and Installer notes, plus additional troubleshooting & testing notes. It would not contain detailed circuit board info or other essential detail that would help a renegade manufacturer copy the product. This document would not normally be provided to the operator or general installer, but where a distributor is acting as the first point-of-contact for an end-user, it would be appropriate for them to have access to this more comprehensive product information.
Click here to return to CREATING A NEW PRODUCT
