Technical and operational documentation (for products) is a voluminous set of documents for a manufactured or marketed product that accompanies the product at all stages of the life cycle from the purchase of raw materials to its disposal.

 

 

Each significant stage should be documented along with individual parameters. Types of technical documentation differ in the type of product for which it is intended.The content of technical documentation depends on the type of product and the requirements of regulatory legal acts to it. Thus, for example the technical regulation TR CU 010/2011 obliges to prepare a safety justification .

 

Additionally, technical documentation can serve as proof of conformity when certifying or declaring goods.

 

The development stages consist of several items. The first step is to prepare a technical task, then projects are created, which are subsequently approved and approved.

 

 

How professionals work on technical documentation before putting into production:

 

  • Prepare a rationale for the development of products taking into account all applicable requirements.

 

  • Conduct an evaluation analysis.

 

  • Determine the list of necessary documentation.

 

  • Create technical specifications and other documents (in their absence from the customer).

 

  • Prepare samples and organize tests (if necessary).

 

Operating documents

Operational document:

 

  • a design document that, individually or in combination with other documents, defines the rules for operating the product and / or reflects information certifying the values of the main parameters and characteristics (properties) of the product guaranteed by the manufacturer, guarantees and information on its operation during the established service life.

 Types of operational documents 

NAME

DEFINITION

MANUAL

A DOCUMENT CONTAINING INFORMATION ABOUT THE DESIGN, PRINCIPLE OF OPERATION, CHARACTERISTICS (PROPERTIES) OF THE PRODUCT, ITS COMPONENTS AND INSTRUCTIONS NECESSARY FOR THE CORRECT AND SAFE OPERATION OF THE PRODUCT (INTENDED USE, MAINTENANCE, CURRENT REPAIR, STORAGE AND TRANSPORTATION) AND ASSESSMENTS OF ITS TECHNICAL CONDITION DURING DETERMINING THE NEED TO SEND IT FOR REPAIR, AS WELL AS INFORMATION ON THE DISPOSAL OF THE PRODUCT AND ITS COMPONENTS.

FORM

A DOCUMENT CONTAINING INFORMATION CERTIFYING THE MANUFACTURER'S GUARANTEES, THE VALUES OF THE MAIN PARAMETERS AND CHARACTERISTICS (PROPERTIES) OF THE PRODUCT, INFORMATION REFLECTING THE TECHNICAL CONDITION OF THIS PRODUCT, INFORMATION ON CERTIFICATION AND DISPOSAL OF THE PRODUCT, AS WELL AS INFORMATION THAT IS ENTERED DURING ITS OPERATION (DURATION AND OPERATING CONDITIONS, MAINTENANCE, REPAIR AND OTHER DATA).

THE PASSPORT

A DOCUMENT CONTAINING INFORMATION CERTIFYING THE MANUFACTURER'S GUARANTEES, THE VALUES OF THE MAIN PARAMETERS AND CHARACTERISTICS (PROPERTIES) OF THE PRODUCT, AS WELL AS INFORMATION ON CERTIFICATION AND DISPOSAL OF THE PRODUCT.

LABEL

A DOCUMENT CONTAINING THE MANUFACTURER'S GUARANTEES, THE VALUES OF THE MAIN PARAMETERS AND CHARACTERISTICS (PROPERTIES) OF THE PRODUCT, INFORMATION ABOUT THE CERTIFICATION OF THE PRODUCT. 

EDUCATIONAL AND TECHNICAL POSTERS

A DOCUMENT CONTAINING INFORMATION ABOUT THE PRODUCT DESIGN, PRINCIPLES OF OPERATION, METHODS OF USE, MAINTENANCE, AREAS OF TECHNICAL KNOWLEDGE WITH NECESSARY ILLUSTRATIONS.

SPECIAL OPERATING INSTRUCTIONS

A DOCUMENT CONTAINING SPECIAL REQUIREMENTS RELATED TO THE INTENDED USE, MAINTENANCE, CURRENT REPAIR, STORAGE, TRANSPORTATION AND DISPOSAL, DRAWN UP IN THE FORM OF INDEPENDENT PARTS OF THE ED OR IN THE FORM OF ANNEXES TO THEM.

An interactive electronic document is a combined document and is intended:

 

  • - to provide reference material about the device and the principles of operation of the product;

 

  • - training of personnel in the rules of operation, maintenance and repair of the product;

 

  • - providing personnel with reference materials necessary for the operation of the product, the performance of routine maintenance and repair of the product;

 

  • - providing information on the technology of performing operations with the product, the need for the necessary tools and materials, the number and qualifications of personnel;

 

  • - equipment diagnostics and troubleshooting;

 

  • - ensuring the order of materials and spare parts;

 

  • - planning and accounting for routine maintenance;

 

  • - data exchange between the consumer and the supplier, etc.

 

The electronic display system must provide a unified way of interaction with the user for all data contained in operational documents and a technique for presenting information:

 

 

  • - interactive electronic documentation data is provided to the end user through an electronic display system - a software package that provides visualization of the information contained in the operational documentation and interactive interaction with the user.

 

  • - the database of interactive electronic documentation should have a structure that allows the user to quickly access the necessary information. The database may contain textual and graphical information, as well as data in multimedia form (audio and video data). The requirements for the nomenclature and composition of information, as well as for the logical data model of the interactive electronic documentation database, should be regulated by regulatory documents for products of specific types of equipment, taking into account their specifics.

 

  • - the electronic display system should provide a method of interaction with the user and options for presenting information that is unified for all interactive electronic documents for products of specific types of equipment.

 

The requirements for the visual presentation of multimedia information in interactive electronic documentation are set by the developer

 

The following options for completing and transferring

operational documents to the end user are allowed

The reference system of interactive operational documents should provide the user with:

 

  • - access to context-sensitive help needed when performing certain actions or in specific situations;

 

  • - obtaining descriptive information with explanations of individual technical points, with an explanation of special terms;

 

  • - information assistance on the use of operational documents and the electronic display system, for example, how to access specific information, how to use the functions of the display system;

 

  • - access to additional information related to the technical content of operational documents.

 

The help system should be provided for all sections of operational documents and be available during the entire session of working with operational documents.

 

 

PROMERY Ltd., will help to avoid common mistakes with self-development of technical documentation. We use our own experience and extensive theoretical base in our professional activities.

 

If you already have a set of technical documentation, but are not sure that it is enough or, are not sure of the design, we are ready to accept for review both sets of technical documentation and individual documents. Reviewing is carried out by us in several directions:

 

  • the documentation is brought into line with the current technical regulatory legal acts;

 

  • Bringing documents to a common terminology and uniform style.