Guidelines to OEMs IETM Hyderabad

General Guidelines to be followed by OEMs while making Manuals

This document briefly covers the guidelines to be followed by OEMs (Original Equipment Manufacturers) while preparing manuals.

1. Administrative Information


2. Introductory information


3. Definition of Acronyms, Terms and Abbreviations

The above information is also required from OEMs along with approved manuals which are to be integrated into IETM software.

Multiple Skill Level Tracks and Comprehensibility can be followed as per the requirement of the system that is to be delivered. (To be decided by OEM)
The quality of the graphics section is highly ad****ble to follow. The items and systems hierarchy section is also good to follow.

1. Administrative Information:

All IETM shall contain the following administrative information for subsequent user selectable display:

• Identification of the “Title of The Technical Manual”, assigned “Technical Manual Number”, as applicable.


• Classification Level of the IETM (shall also be presented upon initial entry to the IETM by the user)


• Date, baseline date and dates of the latest/all previous changes.


• Verification, change or revision status as applicable.


• Method of obtaining additional copies and the format of such electronic copies


• Distribution statement.


• Summary of documents and/or technical manuals that are referred in the IETM but not included in the automatically accessible data (hyperlink) available to the IETM.

2. Introductory Information:

All IETM shall contain information, which explains the purpose and scope (e.g., organizational level troubleshooting and corrective maintenance for a particular system), content, and organization of the IETM.

This section shall present the range of tasks covered by the IETM and relate the purpose and scope of the manual.

3. Definition of Acronyms, Terms and Abbreviations:

• A glossary of terms used in the IETM including all acronyms, abbreviations and special terms shall be incorporated in the IETM and shall be directly accessible in all IETM presentations.

4. Warnings, Cautions, and Notes:

Technical information shall be supplemented with warnings, cautions and notes in such a way as to:

1. Attract the user’s attention to correct practices, procedures and conditions which, if not adhered to, could lead to injury or equipment damage.


2. Warn the user against the performance of certain hazardous actions, and/or,


3. Follow specific steps leading to the safe performance of the procedures.

5. Multiple Skill Level Tracks:

• When required, technical information shall be available in multiple skill-level tracks.


• For example, in the case of novice level and expert level skills, technical information shall be available in each of the two separate and complete tracks representing the two skill levels.


• The novice level track shall contain all information necessary to carry out a task step by step, while the expert level track may provide only a checklist or a description in broader terms.


• The expert would have the option of referring to the novice-level information also.

6. Comprehensibility:

The following guiding principles shall be followed to ensure the comprehensibility of data in an IETM:

• Information should be in a descriptive text manner. This text must be consistent in style, terminology, and format.


• The functions of the system/component, the inputs, outputs, interfaces, and principles of operation are to be described.


• Any special features are to be listed and explained.


• The location of the component/part in the system is to be indicated.


• Each paragraph of the text should be limited to a single idea. Each sentence should be limited to a single thought. Short and familiar words are to be used. Rules of Service writing shall be adhered to.


• The length of a sentence shall not exceed 20 words. The average paragraph shall not exceed 6 sentences.


• Steps and explanations shall be constructed as fully integrated text and graphics modules.


• Text shall be presented in a logical order; e.g., as in an operational sequence or in a signal flow sequence.


• The IETM shall contain only the information required. Any additional information which could be useful, but not essentially required, shall be provided as HELP

Share