This article needs additional citations for verification . (May 2007) (Learn how and when to remove this template message) |
An IETM or Interactive Electronic Technical Manual is a portal to manage technical documentation. IETMs compress volumes of text into just CD-ROMs or online pages which may include sound and video, and allow readers to locate needed information far more rapidly than in paper manuals. IETMs came into widespread use in the 1990s as huge technical documentation projects for the aircraft and defense industries.
In the United States, in the late 1970s, the US Military began to look at other ways to produce technical manuals. With the introduction of computer technology it was theorized that moving technical manuals to an electronic format would obtain a cost savings, allow better integration with other logistics systems and improve usability of the technical material.
Research was performed in the 1970s and 1980s by all branches of the US military to obtain information on what the goals should be for the electronic technical manuals. Early research was conducted at the Army Communicative Technology Office at Ft. Eustis, the Air Force Human Resources Laboratory (now called Armstrong Laboratory) at Wright Patterson Air Force Base, and the David Taylor Research Center (now called Naval Surface Warfare Center, Carderock Division) in Bethesda, Maryland. [1] Programs developed by the Navy, Navy Technical Information Presentation System (NTIPS) and the Air Force, Computer-based Maintenance Aid System (CMAS), were used along with user surveys, technological analysis and design studies to come up with the basic concepts for IETMs. Based on field tests with technicians maintaining military equipment, the tests found that performance was greatly improved and dramatic improvement occurred for inexperienced technicians. One questionnaire found that 90% of the technicians preferred electronic manuals and found them easier to use. [1] [2]
Other examples of the improvements from IETMs included:
Because of the positive results, the Department of Defense identified the need for standardization of the IETM development. In 1987 a joint military and commercial group was formed consisting of the Office of the Secretary of Defense Computer-assisted Acquisition and Logistics Support (OSD CALS) and Aerospace Industries Association (AIA). This group developed concepts for IETM authoring, IETM presentation and data interchange which were used as the basis for standard development. In 1989 the US Navy, Air Force and Army formed an ad-hoc group to determine the best way to create standards for IETMS. Input from the use of NTIPS and CMAS, later renamed Integrated Maintenance Information System(IMIS), were used along with input from the CALS Industry Steering Group (ISG) Paperless Technical Manual Committee, the Navy A-12 Program, The Air Force ATF Program, and the Army PMDE Program's IETM Style Guide as a starting point for a working group for IETM standards. The group came out with the first formally issued set of standards in 1992. [2] By 1994, Senior R&D Engineer Michael Weldon, working on behalf of LORAL Corporation, developed a demonstration White Paper IETM describing the use of an IETM utilizing an eyeglass Monitor interfaced with a portable belt mounted CD Player for hands free use by technicians in the field, i.e. as when working on a tower 60 feet AGL.
The Tri-Service group came up with three standards:
The Tri-Service Group also came up with a roadmap that went through to 1997 for revision of the standards and the creation of documentation explaining the standards. [2]
The functionality of IETMs systems is broken down into six classes. But these classes are more like points in a spectrum of features with most real-world IETM products falling somewhere in between two classes.
Due to the imprecise nature of the generic descriptions used in the class and level description of IETMS, IETMs are now defined using a Functionality Matrix. IETMs can have many different features and the Functionality Matrix is used as a checklist of which features are required for a particular IETM. This checklist more precisely defines what functionality an IETM has, and allows clearer communication between an IETM developer and the IETM customer. Classes and levels of IETMS are no longer regarded as acceptable descriptors of IETMs.
The IETM functionality matrix was first developed by the US Aerospace Industries Association (AIA) Product Support Committee. It is used in most US military technical data specifications as well as S1000D, the international IETM standard.
Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScript.
Hypertext is text displayed on a computer display or other electronic devices with references (hyperlinks) to other text that the reader can immediately access. Hypertext documents are interconnected by hyperlinks, which are typically activated by a mouse click, keypress set or by touching the screen. Apart from text, the term "hypertext" is also sometimes used to describe tables, images, and other presentational content formats with integrated hyperlinks. Hypertext is one of the key underlying concepts of the World Wide Web, where Web pages are often written in the Hypertext Markup Language (HTML). As implemented on the Web, hypertext enables the easy-to-use publication of information over the Internet.
The World Wide Web (WWW), commonly known as the Web, is an information system where documents and other web resources are identified by Uniform Resource Locators, which may be interlinked by hypertext, and are accessible over the Internet. The resources of the WWW are transferred via the Hypertext Transfer Protocol (HTTP) and may be accessed by users by a software application called a web browser and are published by a software application called a web server.
A website or web site is a collection of related network web resources, such as web pages, multimedia content, which are typically identified with a common domain name, and published on at least one web server. Notable examples are wikipedia.org, google.com, and amazon.com.
Founded in 1981, Interleaf was a company that created computer software products for the technical publishing creation and distribution process. Its initial product was the first commercial document processor that integrated text and graphics editing, producing WYSIWYG output at near-typeset quality. It also had early products in the document management, electronic publishing, and Web publishing spaces. Interleaf's "Active Documents" functionality, integrated into its text and graphics editing products in the early 1990s, was the first to give document creators programmatic access to virtually all of the document's elements, structures, and software capabilities.
A document management system (DMS) is a system used to track, manage and store documents and reduce paper. Most are capable of keeping a record of the various versions created and modified by different users. In the case of the management of digital documents such systems are based on computer programs. The term has some overlap with the concepts of content management systems. It is often viewed as a component of enterprise content management (ECM) systems and related to digital asset management, document imaging, workflow systems and records management systems.
A content management system (CMS) is a software application that can be used to manage the creation and modification of digital content. CMSs are typically used for enterprise content management (ECM) and web content management (WCM). ECM typically supports multiple users in a collaborative environment by integrating document management, digital asset management and record retention. Alternatively, WCM is the collaborative authoring for websites and may include text and embed graphics, photos, video, audio, maps and programme code that display content and interact with the user. ECM typically includes a WCM function.
Documentation is a set of documents provided on paper, or online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, on-line help, quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other on-line applications.
A technical writer is a professional information communicator whose task is to transfer information (knowledge) between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers research and create information through a variety of delivery media. Example types of information include online help, manuals, white papers, design specifications, project plans and software test plans. With the rise of e-learning, technical writers are increasingly becoming involved with creating online training material.
In computing, a digital object identifier (DOI) is a persistent identifier or handle used to identify objects uniquely, standardized by the International Organization for Standardization (ISO). An implementation of the Handle System, DOIs are in wide use mainly to identify academic, professional, and government information, such as journal articles, research reports and data sets, and official publications though they also have been used to identify other types of information resources, such as commercial videos.
Enterprise content management (ECM) extends the concept of content management by adding a time line for each content item and possibly enforcing processes for the creation, approval and distribution of them. Systems that implement ECM generally provide a secure repository for managed items, be they analog or digital, that indexes them. They also include one or more methods for importing content to bring new items under management and several presentation methods to make items available for use.
A subject-matter expert (SME) or domain expert is a person who is an authority in a particular area or topic. The term domain expert is frequently used in expert systems software development, and there the term always refers to the domain other than the software domain. A domain expert is a person with special knowledge or skills in a particular area of endeavour. The development of accounting software requires knowledge in two different domains: accounting and software. Some of the development workers may be experts in one domain and not the other.
MIL-STD-498 (Military-Standard-498) was a United States military standard whose purpose was to "establish uniform requirements for software development and documentation." It was released Nov. 8, 1994, and replaced DOD-STD-2167A, DOD-STD-7935A, and DOD-STD-1703. It was meant as an interim standard, to be in effect for about two years until a commercial standard was developed.
An electronic flight bag (EFB) is an electronic information management device that helps flight crews perform flight management tasks more easily and efficiently with less paper. It is a general purpose computing platform intended to reduce, or replace, paper-based reference material often found in the pilot's carry-on flight bag, including the aircraft operating manual, flight-crew operating manual, and navigational charts. In addition, the EFB can host purpose-built software applications to automate other functions normally conducted by hand, such as take-off performance calculations.
Pagination, also known as paging, is the process of dividing a document into discrete pages, either electronic pages or printed pages.
A specification often refers to a set of documented requirements to be satisfied by a material, design, product, or service. A specification is often a type of technical standard.
This military standard established the Standard Generalized Markup Language (SGML) and the Extensible Markup Language (XML) requirements for use in Army digital publications. Within this military standard, Army publications SGML/XML requirements are separated by publication types. There are specified sections for administrative publications, training and doctrine publications, technical and equipment publications and Global Combat Support System-Army (GCSS-A). This new publication of the standard contains the XML requirements for Technical Manuals (TM) developed in accordance with the functional requirements contained in MIL-STD-40051-1 and MIL-STD-40051-2, GCSS-A collection and reporting of maintenance data developed in accordance with MIL-STD-3008, and administrative publications developed in accordance with AR 25-30. The XML requirements are applicable for the development, acquisition, and delivery of Electronic and Interactive Electronic Publications (EP/IEP) such as Electronic and Interactive Electronic Technical Manuals (ETM/IETM). The previous SGML for training and doctrine publications functional requirements, developed in accordance with TRADOC Reg 350-70 and TRADOC Reg 25-36, remain unchanged. Specific Interactive Multimedia Instruction (IMI) functionality is currently contained in MIL-PRF-29612, The Development and Acquisition of Training Data Products and TRADOC Reg 350-70, Systems Approach to Training Management, Processes, and Products.
In engineering, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product or a product under development or use. The intended recipient for product technical documentation is both the (proficient) end user as well as the administrator / service or maintenance technician. In contrast to a mere "cookbook" manual, technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product at hand.