Best Practices for Creating Interactive Electronic Technical Manuals (IETM)

In the digital age, the traditional paper-based user-handbooks and technical manuals are being replaced by more interactive and accessible formats known as Interactive Electronic Technical Manuals (IETM). These manuals, which can be accessed on various digital devices, offer a rich and engaging user experience. This article discusses the best practices for creating IETMs that meet the stringent requirements set by JSG 0852:2015 and JSS 0251, ensuring that your technical documentation is user-friendly and comprehensive.

Understanding IETM and Its Levels

An Interactive Electronic Technical Manual (IETM) is an electronic version of a user handbook or technical manual that is designed to be interactive and accessible. While a PDF file is a common format, an IETM goes beyond mere static information. JSG, the India Defence Agency, defines standards for such documentation through JSG 0852:2015. This standard outlines the requirements for creating IETMs, ensuring they are consistent and user-friendly.

There are several levels of IETM, each with increasing complexity:

Level 1 IETM: A basic IETM, which is essentially a PDF file. This is the most basic form and is often referred to as a Level -1 IETM. Level 2 IETM: This involves cross-referencing sections of the document using hyperlinks. It ensures that users can easily navigate through related sections of the manual. Level 3 IETM: Here, all manuals are converted into HTML pages and arranged in a linear structure, much like a table of contents tree. Sections and sub-sections are maintained as in the original manual, with additional navigation options such as 'Next' and 'Previous' buttons, search functionalities, and tabs for manuals and drawings. Level 4 IETM: This is the most advanced level, where the manuals are converted into a database, and an IETM Viewer is used to access and view this data. The IETM Viewer is a web application that allows users to interact with the database via a user-friendly interface.

Key Considerations for Level 1 IETM

For Level 1 IETMs, the primary focus is on providing users with a comprehensive and easily navigable document. Here are some best practices to keep in mind:

Compliance with Standards: Ensure that your manual adheres to the JSG 0852:2015 standard. This includes the design of the front page, table of contents, headers, footers, index of amendments, and the structure of the content. Professional Design: Use a professional and clear layout to enhance readability. This includes well-organized headings, subheadings, and consistent formatting. Accuracy and Detail: Ensure that the information is accurate and detailed, providing users with clear instructions and necessary data. Review and Proofreading: Conduct thorough reviews and proofreading to eliminate any errors or ambiguities.

Enhancing with Hyperlinks (Level 2)

For Level 2 IETMs, the focus is on cross-referencing sections using hyperlinks. Here are some best practices:

Linking Mechanism: Ensure that hyperlinks are clearly denoted and provide context when referenced in the text. Consistent Navigation: Maintain a consistent way of linking across all sections to avoid confusion. Older Standards Integration: If you are familiar with JSS 0251, leverage the layout and design of your existing User-Handbooks (UHBs) or technical manuals while incorporating hyperlinks. User-Friendly: Ensure that the hyperlinks are user-friendly and that users can easily understand and navigate the cross-references.

Advanced Navigation (Level 3)

Level 3 IETMs take the navigation capabilities to the next level by converting the manual into HTML pages. Here are some best practices:

Structured Navigation: Use a structured table of contents where each section and sub-section is clearly defined and easily accessible. Interactive Features: Incorporate features such as 'Next', 'Previous', and 'Search' buttons to enhance user interaction. Tabbed Navigation: Use tabs for manuals and drawings to provide a streamlined and organized interface. Consistency: Ensure that the formatting and navigation are consistent throughout the entire manual.

The Most Advanced Level (Level 4)

For Level 4 IETMs, the focus is on creating a database-driven system and using an IETM Viewer. Here are some best practices:

Database Management: Ensure that the database is well-structured, with all relevant information easily accessible. Web Application Development: Develop a user-friendly web application that users can access through a browser. Data Security: Implement robust security measures to protect the data and ensure data integrity. User Feedback: Regularly collect user feedback to improve the IETM Viewer and the overall IETM system.

Conclusion

Creating an Interactive Electronic Technical Manual (IETM) involves a series of steps and considerations. From the basic PDF format to advanced database-driven systems, each level provides greater interactivity and user engagement. By following the best practices outlined above, you can ensure that your IETM is compliant with JSG 0852:2015, JSS 0251, and other relevant standards, providing your customers with an informative, easy-to-use, and engaging technical manual.