NAVAIR INSTRUCTION 4120.11 From: Commander, Naval Air ...

NAVAIR INSTRUCTION 4120.11 

NAVAIRINST 4120.11 

AIR-6.8.5 

DATE 

From: 

Subj: 

Ref: 

Encl: 

Commander, Naval Air Systems Command 

POLICY FOR PREPARATION AND STANDARDIZATION OF NAVAIR 

INTERACTIVE ELECTRONIC TECHNICAL MANUALS (IETMS) 

(a) DEPSECDEF Memo of 2 Jul 97, “Policy for the 

Transition to a Digital Environment for Acquisition 

Programs” 

(b) USD(A&T) memo of 15 Jul 97, “Guidance for the 

Transition to a Digital Environment for Acquisition 

Programs” 

(c) DON memo of 23 Oct 04, “DON Policy on Digital 

Product/Technical Data” 

(d) USD(A&T) memo of 23 Sep 2004, “Product Support 

Boundaries” 

(1) IETM Implementation Guidance 

(2) Requirements for the Acquisition of Technical Data 

Presentation Products 

(3) ETM/IETM Functionality Matrix 

(4) NAVAIR Interactive Electronic Technical Manuals 

(IETM) Common Look and Feel Requirements 

(5) Amplifying XML, S1000D, and MIL-STD-3001 Information 

1. Purpose. To provide policies and guidance for determining 

functional requirements of Naval Air Systems Command IETMs, 

provide specification information, and set forth guidance for 

the look and feel of the display output. 

2. Scope. This instruction applies to all NAVAIR activities and 

to the Aviation Program Executive Offices (PEOs) supported by 

NAVAIR HQ.


Subj: 



3. Policy. 

a. References (a) through (d) established the goal of digital 

operations as the method of choice for all acquisition 

management and life cycle support information. To comply with 

DoN requirements and NAVAIR CIO eXtensible Markup Language 

(XML) policy, all NAVAIR technical manuals (TMs) shall be 

acquired and authored in XML. NAVAIR recognizes three 

available options that are compliant with references (a) and 

(c). These are: 

(1) MIL-STD-3001, Preparation of Digital Technical 

Information for Multi-Output Presentation of Technical 

Manuals 

(2) International Standard for Technical Manuals, Aerospace 

and Defense Industries Association of Europe (ASD) Spec 

S1000D, International Specification for Technical 

Publications Utilizing a Common Source Data Base. 

(3) MIL-M-81310, Manuals, Technical: Airborne 

Weapons/Stores Loading/Weapons Assembly/Support Equipment 

Configuration. 

b. Reference (d) recommends the use of the S1000D 

specification for acquiring and converting technical manuals. 

It should be the specification of choice for all ACAT I and II 

programs. Program Managers shall review both it and MIL-STD- 

3001 and make their decision based on a business case or 

cost/benefit analysis. Enclosure (1) provides implementation 

guidance for assistance in choosing the best alternative 

standard. ACAT III and IV, or programs with major upgrades or 

changes to technical manuals, may chose to utilize S1000D and 

invest in business rule development to preclude the 

requirement to convert in the future. 

c. In order to satisfy fleet requirements for standardization 

and to fully realize the benefits of IETMs, it is necessary to 

reduce the variation in their creation. Towards this end, 

enclosures (2) through (4) have been developed as acquisition 

tools to enable more standardization in the IETM end products 

delivered to the fleet customer. 

2


Subj: 



d. Enclosure (2) is a description of the various IETM 

functional capabilities and a guide for using the 

functionality matrix. Enclosure (3) is the matrix itself. It 

is designed to serve as a program manager’s “shopping list” 

for technical data functional capabilities. 

e. Common Look and Feel across IETM types is important to the 

fleet customer. Enclosure (4) describes screen layouts, 

navigation and other basic “look and feel” requirements for 

NAVAIR IETMS. 

f. Amplifying information describing XML, MIL-STD-3001, and 

S1000D is provided in enclosure (5). 

4. Responsibilities. 

a. Program Managers shall: 

(1) Select the appropriate IETM development specification 

based on an analysis of functional requirements and cost 

benefits. 

(2) Ensure that contract requirements for new acquisitions, 

major updates to existing IETMs, and legacy conversions are 

assembled using enclosures (1) through (3). 

(3) Implement Navy Marine Corps Internet (NMCI) 

requirements with respect to desired IETM functionalities. 

(Those that require executable files will not be acceptable 

in an NMCI environment and will require certification 

testing for each and every upgrade). 

(4) Acquire all new IETMS in accordance with the “Look and 

Feel” requirements set forth in enclosure (4). 

(5) Assess legacy IETMs against the Common Look and Feel 

and develop migration plans to achieve the level of 

standardization reasonable for their program and customer 

Consider economic feasibility and the fleet goal for 

standardization. Complete and submit migration plans, with 

estimated completion dates, to NAVAIR 6.8 within six months 

of promulgation of this instruction. Submit annual updates 

to the plan, delineating progress and/or changes. 

3


Subj: 



(6) When applying S1000D, participate with the Product Data 

Division in the development of a single set of documented 

business rules that will support all NAVAIR programs. 

(7) When procuring or using IETMs, provide representatives 

to the NAVAIR IETM working group. 

(8) Work with the Aviation Readiness and Resource Analysis 

Department Head to ensure that budgeting and funding is set 

aside to author or convert TMs as necessary, and to permit 

the use of the approved standards. 

(9) Receive approval from the Aviation Readiness and 

Resource Analysis Department Head, AIR 6.8.5, and AIR-00 

CIO functional area manager subject matter experts for the 

development of alternative toolkits/viewers and changes to 

the existing toolkit including the viewer. 

(10) Forward any deviation/waiver requests from the 

standards/specifications, to the NAVAIR 6.8.5 Program 

Technical Data Liaisons. Include a description of the 

proposed deviation/waiver, all rationale to support the 

request, and impact of denial. 

b. NAVAIR Product Data Division shall: 

(1) Form and chair NAVAIR’s IETM working group, comprised 

of representatives from programs procuring or using IETMs. 

The purpose of this group is to develop and maintain NAVAIR 

IETM requirements, ensure interoperability, and eliminate 

stove-piped or proprietary solutions. 

(2) Act as NAE SME, and portfolio manager of all funds and 

task assignments contributing to NAVAIR Enterprise IETM 

business rules and viewer(s). 

(3) Review and respond to any deviation/waiver requests 

submitted per paragraph 4.a.(10) of this instruction. 

4


Subj: 



5. Review. NAVAIR 6.8.5 shall review this instruction 

annually and provide recommendations for revision or 

cancellation to the Commander. 

W. B. MASSENBURG 

Distribution: 

SNDL: FKA1A (Deputy Commanders, Assistant Commanders, Command 

Special Assistants, Program Managers, Level 1 Leaders, Level 2 

Leaders, PEO (T), PEO (A), PEO (W), APEO (L) A, T, W, 1.0, 

PMA201, PMA202, PMA205, PMA207, PMA208, PMA209, PMA213, PMA222, 




NAVAIR-1.0, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9, 

4.10, 4.11, 6.0, 6.0E, 6.6, 6.7, 6.8, 6.9; NADEP JAX 4.0, 6.0; 

NADEP NORTH ISLAND 4.0, 6.0; NADEP CHERRY POINT 4.0, 6.0; NAWC 

AD LAKEHURST 4.0, 6.0; NAWC AD PATUXENT RIVER 4.0, 6.0, NAWC WD 

POINT MUGU 4.0, 6.0, NAWC WD CHINA LAKE 4.0, 6.0, NAWC TSD 

ORLANDO 4.0, 6.0 

5


IETM Implementation Guidance 

1. The following guidance is provided for the use of MIL-STD- 

3001, MIL-M-81310, and International Standard S1000D. These 

standards shall be used when acquisition of NAVAIR TMs is a 

requirement, or when converting of legacy TMs to XML. Figure 1 

provides a flowchart of the decision process for selecting the 

proper IETM Specification. 

a. S1000D shall normally be used for: 

(1) All ACAT I and II programs. 

(2) Major weapons systems/equipment TMs going through 

major revisions/updates (i.e. when requiring an update to 

approximately 80% of the manual and not already in a digital 

format stated in reference (c). 

(3) Converting major weapons systems/equipment TMs that 

have more than 10 years of operations and sustainment remaining. 

(4) When the required functionality of the IETM is not 

obtainable using the MIL-STD-3001 Tool Kit. 

(5) Future development or enhancement requirements 

include use of a non-linear database. 

(6) If a business case analysis or cost/benefit analysis 

shows S1000D to be the most cost-effective alternative (i.e., 

Foreign Military Sales distribution or interoperability). 

b. S1000D may not be the best choice for maintenance card 

decks, NATOPs, or NATIPs. Programs should review the 

specification carefully to determine if it will support their 

requirements for these types of data. 

c. MIL-STD-3001 shall normally be used for Weapons 

systems, aeronautical equipment, engines, airborne 

weapons/equipment, and support equipment when the business case 

does not justify the use of S1000D. 

d. MIL-M-81310 shall normally be used for weapons 

loading/WAMs manuals if S1000D does not support. 

e. S1000D and MIL-STD-3001 shall not be used for Legacy 

TMs when there is no return on investment or improvement in 

maintenance capability gained by conversion. In these 

instances, updates and revisions should be prepared in 

accordance with the applicable specifications and then converted 

to a PDF format. 

1 Enclosure (1)


REQUIREMENTS 

FOR THE ACQUISITION 

OF 

TECHNICAL DATA 

PRESENTATION PRODUCTS 

Enclosure (2)


EXECUTIVE SUMMARY 

Over the last decade, the use of Electronic Technical 

Manuals/Interactive Electronic Technical Manuals (ETMs/IETMs) has 

consistently increased as the desired method of technical manual 

acquisition. The use of ETMs/IETMs has shown great promise in 

terms of reduction of distribution costs, data access times and 

reducing the product mean time to repair. The proliferation of 

these new ETM/IETM acquisitions has led to many different ETM 

systems, technologies, and functionalities. The lack of any ETM 

acquisition standard has significantly complicated acquisition 

and contracting of technical information for program managers. 

To address this situation, the Joint Aviation Logistics Board 

tasked a joint team of government and industry ETM pioneers to 

develop a methodology and resources to aid the acquisition 

manager in contracting and pricing specific ETM functionalities. 

This has been an ongoing effort for several years that has 

resulted in the development of a two dimensional checklist (the 

Functionality Matrix) and this document that guides the 

acquisition manager to select the functional elements required to 

provide the level of presentation that will best support the 

effort and assist him or her in determining a subjective cost for 

procurement of the product. 

BACKGROUND 

Implementation of ETMs has caused a significant change in that 

the contracted deliverables are digital files and databases 

rather than traditional paper pages. There is an accompanying 

paradigm shift from page based to new costing methodologies. To 

address these changes, ETM acquisition needs to focus on 

functionality rather than pages or class system. A tool is needed 

to help the acquisition manager. 

The primary motivation for contracting ETMs should be to provide 

cost effective, maintenance-aiding tools to the war fighter. 

There are a number of decisions to be considered when acquiring 

ETMs, several of which will have a direct effect on the type of 

technical data contracted. It is the purpose of this document to 

provide resource tools to help the acquisition manager contract 

the functionality required in a manner that can subsequently be 

priced by bidders and compared and contrasted in a competition. 

This tool is intended to give some idea of the relative 

complexities of these functionalities, which equate to costs. 

Enclosure (2) 2


RECOMMENDED PROCESS FOR ETM/IETM CONTRACTING 

The matrix is intended to allow ETM programs to define their 

requirements in language that is accepted and understood by 

industry. For a competitive bid, it’s anticipated that the 

bidders would provide completed matrices back with pricing 

information that would enable "apples to apples" evaluation. Once 

pricing has been completed, the acquisition officer can review 

the pricing provided by the offerors with the intent that 

comparisons can be made from the completed matrices. These can 

serve as a basis for fact-finding as well. 

This tool can help the acquisition manager evaluate the cost 

benefit associated with ETMs and trade off higher cost 

functionality requirements with those of lower cost. 

USE OF THE FUNCTIONALITY MATRIX 

The matrix is intended to serve as a "shopping list" for desired 

capabilities for various types of typical technical data. Some of 

the functionalities for specific data types are mutually 

exclusive and therefore grayed out. For example, in the 

navigation functionality, it is anticipated that one method or 

functionality would be used for all data types. There are also 

some conditional relationships by definition that need to be 

considered by the acquisition manager e.g. IPB/IPC (Illustrated 

Parts Breakdown/Illustrated Parts Catalog) data would have to be 

acquired in order to impart the Parts Ordering functionality (See 

attachments). 

For the purposes of this document and its attachments, “tech 

data” refers to the data traditionally found in technical 

manuals and publications (not necessarily including engineering 

or program data). 

The matrix is broken out into two separate sheets representing 

different ETM strategies. There is one matrix each for page 

oriented publications, and Interactive Electronic Publications 

(IETP). 

Page oriented publications are presented in a linear or document 

oriented manner. The data author largely predefines the 

sequence of the data presentation. Page oriented publications 

can be designed for traditional printing or for electronic 

display. Electronically displayed page oriented publications 

are sometimes called Electronic Technical Manuals (ETM) or 

Electronic Technical Publications (ETP). 

3 Enclosure (2)


IETP tech data is displayed in a non-document formatted fashion. 

There are high levels of interactivity between the data and the 

user. The sequence of presentation is dictated by inputs from 

the user, external sources or events (as in diagnostics). Nonlinear 

databases, if populated correctly, can also provide 

tremendous life cycle savings due to data reuse. 

HORIZONTAL AXIS 

Using the horizontal axis, identify the data types required. 

• The data types and the level of detail to be acquired 

should be commensurate with the maintenance philosophy 

for the weapon system or equipment. Inputs from the 

training command should also be considered in areas 

where there may be some training or courseware 

functionality that may be accommodated by the use of 

ETMs. Legacy TMs (if available) for the weapon system 

or a similar system should be considered as a guide 

for selecting data types. 

• It should be understood that different weapons systems 

will have different needs relative to data types. The 

Functionality Matrices attached provide examples of 

common data types used by weapons systems. 

Customization of the data types by the acquisition 

activity is expected. 

The Complexity Factor is a relatively weighted number assigned 

to each feature within the functional categories to indicate the 

abstracted complexity of a listed ETM feature when compared 

against the other features within that Functionality Category. 

A 1.0 factor being used as the baseline value for all 

measurements with all other factor values being a projected 

complexity of the listed value times greater then 1.0. For 

example, the ‘Key Word Search’ feature of the “Navigational” 

Functional Category is listed as a 1.0 feature, while the 

‘Access by Modification’ feature is listed as a 1.5 feature. 

This would mean that the ‘Access by Modification’ feature is 

considered one and half times as difficult to develop as the 

‘Key Word Search’. But the ‘Network Distribution’ feature also 

listed as a 1.5 feature is not comparable for complexity 

measurement against either the ‘Key Word Search’ or the ‘Access 

by Modification’ features because it is in the “Distribution” 

Functional Category and both of the others are in the 

“Navigational” Functional Category. 

Enclosure (2) 4


VERTICAL AXIS 

Using the vertical axis, identify the appropriate required 

functionality. 

• Review the definitions for the features and functions 

to determine if this is an actual need for your 

program. 

• Remember, higher complexity numbers will generally 

mean more dollars to acquire the functionality. 

• Higher investment may ultimately result in reduced 

total ownership costs for the weapon system. 

• Perform tradeoffs and life cycle cost/cost benefit 

analysis to determine more detail on payback 

opportunities. 

FINAL DELIVERABLE IMPACT 

Cells located at the intersections of the Functionality rows 

and the Content Type columns are either filled solid, 

patterned or empty. This is done to indicate the 

feasibility of specific functionalities for use with 

specific content types. 

• If an entire row is filled with a dot pattern, it means 

that the functionality cannot (or likely will not) be 

applied to individual content and instead will apply 

universally to the ETM/IETP. 

• If an entire row is white, it means that the 

functionality can be applied to an entire ETM/IETP or 

to any of the individual content types per the 

customer’s requirements. 

• If individual blocks in a row are solid, it means that 

the functionality cannot be applied to an entire 

ETM/IETM, but only to certain individual content types 

per the customer’s requirements. Those solid cells 

indicate where the functionality cannot apply. 

To specify the need for a specific functionality to be 

implemented with a specific content type, “check” the cell at the 

intersection. To select a functionality that applies to all 

content types, “check” the cell in the Final Deliverable Impact 

column. 

5 Enclosure (2)


If desired, the acquisition agent may also use the Final 

Deliverable Impact column to capture and coordinate notes 

reflecting the importance of the functionality to the program 

(i.e.; shall have, nice to have, do not want, etc.) prior to 

making final requirements decisions. 

FUNCTIONALITY MATRIX DEFINITIONS 

SUMMARY OF CATEGORIES: The following summarizes the 

functional categories at a high level with detailed 

narratives included in Table 1. 

ACCESS: This is the functionality that allows or 

restricts users to view specific ETM data. 

ANNOTATION: This category includes functionalities 

that add electronic notes, comments or other means 

to provide additional explanation and notation of 

the technical data. Consideration using annotation 

is configuration management of maintaining valid 

procedure steps by the organization. 

DELIVERY and DISTRIBUTION: Selection of the desired 

ETM media will drive costs; however, the most 

significant consideration is the readiness of the 

infrastructure at the user level for whatever media 

is acquired. 

DIAGNOSTICS and PROGNOSTICS: ETM diagnostics and 

prognostics can be a significant benefit in reducing 

maintenance times and total ownership costs; 

however, they can also be a sizable cost driver in 

ETM development. Diagnostics span from basic 

standalone troubleshooting procedures to integration 

with the weapon system and other maintenance 

systems. Prognostics may include health monitoring 

and linkage to autonomic logistics systems. 

EXTERNAL PROCESSES: The ETM environment has the 

potential to provide greater functionality by 

interacting with external processes, which are 

outside the technical data, to retrieve and transmit 

information. 

NOTE: Consideration must be given to configuration management of 

the external information. 

Enclosure (2) 6


GRAPHICS: Various levels of graphics display, 

interactivity, and navigation can be implemented 

through ETMs. Examples of these functionalities 

include 

• Point and click on a locator graphic for the 

purpose of “drilling down” to graphic details 

• Links to textual or tabular information 

• Highlighting specific connections in a circuit 

• System simulation expressed graphically 

• Full 3D models that can be rotated with parts 

removed 

The more complex graphical navigational techniques 

often come at a premium for both cost and system 

hardware/software requirements. 

LINKING: ETM basic linking functionality is defined 

as essentially link access or connections to the 

data within the ETM such as from the table of 

contents to the applicable ETM section. Additional 

linkage such as cross-references may require some 

additional effort to maintain. Linking to data items 

external to the ETM can also be acquired. These 

links may be to resources such as material handling 

information or for integration with other related 

information. 

NAVIGATION and TRACKING: ETMs exhibit a number of 

different navigation methods that enable linear and 

nonlinear access through the data. Features such as next 

and back, search, and the use of bookmarks are considered 

to be relatively fundamental and consistent with most 

web-based data presentation techniques. Higher complexity 

navigation techniques include dialog driven interaction, 

voice activated commands and various filtering 

techniques. Examples of filtering characteristics are 

model number, identification number (e.g. tail 

number/BUNO), modification performed, and user 

qualifications. Tracking provides the ability to allow 

recording and subsequent retrieval of ETM activity, as in 

an audit trail. Levels of audit trails include a history 

of the current ETM session (browser history for data 

traversed), logging all actions performed for maintenance 

7 Enclosure (2)


data collection, and integration with training and 

security systems. 

PRINTING: Some ETMs by their nature are intended for use 

in an online environment, with print functionality 

limited primarily to task oriented and screen print 

output. By defining a hard copy output that more closely 

resembles a paper technical manual, the resulting costs 

and complexity rise. 

SPECIAL CONTENT: The inclusion of additional data types 

such as audio, motion video, and animations are 

accommodated relatively easily by most ETM systems; 

however, content generation is often more costly and 

performance issues may arise. 

UPDATES: ETMs support a number of different update 

methodologies that significantly affect the costs of 

sustainment and include Revisions, Changes and Urgent 

Changes (Rapid Action Changes (RACs), etc.). These may 

include change markings or other change indications. 

Updates include any tech data delivery after the initial 

delivery. 

USER OPERATION MODE: User operation mode describes the 

state of network connectivity of the ETM. Cost 

considerations are maintainability, storage, security, 

and context filtering of the IETM and technical data. 

OTHER CONSIDERATIONS 

Hardware selection is a significant program consideration 

and may influence the development and cost of the ETM data. 

There may also be authoring considerations e.g. screen size. 

For example, if the ETM is to be presented on a PDA, the 

data must be formatted specifically for this device and 

multiple operating systems may be required. For touch 

screens, special considerations must be given to human 

factor issues e.g. button sizes. If the ETM will operate in 

a wireless environment, security and connectivity must be 

addressed. Wearable computers have their own unique set of 

human factors and environment considerations. 

Numerous different graphics file formats are available for 

ETM. Unique file formats may require specialized viewers 

and/or processing. Undeclared customization may occur, 

Enclosure (2) 8


creating long-term sustainment difficulties. These 

standards are highly dynamic and require very specific 

requirements definition in the acquisition. 

Configuration management of ETM, its viewers, externally 

referenced files, and its infrastructure offer significant 

challenges. Attention to backward compatibility issues, 

software upgrades and the compatibility of software used 

throughout the ETM environment. 

When the ETM contains classified material or has distribution 

restrictions there should be an indication to remind the user of 

the classification/distribution. The specific markings required 

may vary between international users and requires very specific 

requirements definition in the acquisition. When security 

markings are required, consideration should be given to ensure 

that printed materials will include the security indication as 

well as the displayed material. 

FUNCTIONALITY DEFINITIONS 

The following narratives provide descriptions of each of the 

functionalities identified in the matrix as well as some 

considerations to be made and the range of capabilities that may 

be addressed therein. This table provides identification of the 

category, title of the functionality, a complexity factor, a 

definition of the functionality and an example. The category 

codes used in this table relate to the matrix categories as 

follows: 

Ac = ACCESS 

An = ANNOTATION 

DD = DELIVERY AND DISTRIBUTION 

DP = DIAGNOSTICS AND PROGNOSTICS 

E = EXTERNAL PROCESSES 

G = GRAPHICS 

L = LINKING 

N = NAVIGATION 

P = PRINTING 

S = SPECIAL CONTENT 

U = UPDATES 

Uo = USER OPERATION MODE 

9 Enclosure (2)


Cat Functionality Definition Examples and Comments 

Ac 

Suspend and 

Restart 

The capability to suspend an 

ETM maintenance session at a 

point and then provide the 

maintainer with the ability to 

restart at the point of suspense. 

This entails the use of the audit 

trail. This capability extends 

beyond a user session and 

retains local data. 

For example, during the performance of a 

maintenance session, a part is removed. 

The replacement part is not available in 

supply. The session is suspended and 

subsequently restarted after the part 

becomes available. 

Ac Login Consideration must be given to 

determine if specific profiles, 

user IDs, roles, and 

permissions will be required to 

permit ETM usage. A 

password for log on may or 

may not be required. 

It should be kept in mind, that if 

there is a higher-level 

infrastructure controlling 

access, it should be the 

controlling authority of ETMs. 

ETM access based on the 

training and skill of the 

maintainer would require the 

ETM system link into the 

maintainer’s training records. In 

a stand-alone mode, the 

amount of data required to be 

loaded on to the stand-alone 

device is considerable and 

complex. Consideration must 

be given to the maintenance of 

this data in multiple locations. 

Enclosure (2) 10



An 

Action Complete 

Indicator 

A functionality used to indicate 

the completion of an action. 

This functionality is normally 

associated with, but not limited 

to use with, checklists, as other 

methods may be used (e.g.: 

sign off). The data entered via 

the Action Complete Indicator 

may be retained for state or 

audit trail purposes depending 

on project requirements. An 

Action Complete Indicator will 

not have a given value (other 

than “if checked=completed”). 

This functionality is different 

than, and should not be 

confused with, check boxes 

associated with dialogs. 

An 

Global Data 

Annotation 

This functionality allows the 

end users to store data 

acquired via local inspection. 

Globally accessible annotations 

should be limited in scope and 

required to be approved by the 

end user’s Quality Assurance 

process and be made available 

to the ETM development 

contractor. 

This feature allows local 

maintenance activities to 

supplement the general quality 

assurance checks unique to 

that activity. It should be noted 

that this is a one-way feature. 

Globally accessible 

documentation can only be 

added; it may not be deleted. 

An example of globally accessible 

annotation is a quality maintenance 

supplement indicating the new type of 

lubricant to use. 

Some users of data on CDROM might use 

these Global Data Annotations to provide 

updates to data by quickly revising the 

CDROM to contain the “sticky” notes. 

The TPIRF, DA Form 2028, AFTO Form 

22, AFTO Form 735, and TPDR are 

discrepancy forms that after approval may 

use Global Data Annotations to 

incorporate the data. 

11 Enclosure (2)



An 

Local Data 

Annotation 


storage of locally applicable 

data. These annotations should 

be limited in scope and 

required to be approved by the 

local approval process. 

This feature allows local 

maintenance activities to 

supplement the ETMs. It 

should be noted that this is a 

one-way feature. 

Example: The maintainer may be 

required to use additional filtering in a 

desert environment. 

An 

Personal 

Annotation 

Personal annotation may be 

added or deleted at the end 

user’s discretion and it is 

suggested that it is not retained 

at the end of the maintenance 

session. It is not the intent that 

the personal annotation 

persists with the ETM. The 

capability for persistent 

annotations will be a cost driver 

that requires integration with 

the ETM and a file storage 

methodology to correlate 

unique users to their 

annotation. 

Fig 3. Personal Annotation 

An example of a personal annotation: 

“Noticed that radome latch broken on left 

side notify radar shop.” 

An 

Redlining 

Graphics 

Capability provided to annotate 

graphics through the use of an 

overlay freehand-type drawing 

facility. The capability exists to 

save and attribute redline 

markups. 

Figure 2. Redlining 

Enclosure (2) 12



An Redlining Text Capability provided during 

review process to annotate text 

using markings for deletions 

and insertions. 

DD CD-ROM Distribution and/or delivery by 

compact disk – read only 

memory (CD-ROM). Such 

physical distribution methods 

typically entail issue of a 

complete database thus 

replacing the data in use. This 

replacement constitutes a block 

change update and is 

performed on a periodic basis. 

Requires a CD reader. 

DD DVD Digital Video Disc (DVD) 

distribution and/or delivery 

provides many of the same 

features of distribution and/or 

delivery by CD-ROM with 

greater capacity. Requires a 

DVD drive. [See “CD-ROM”] 

DD 

Network 

Distribution 

Distribution by Internet 

(connections to the world-wideweb 

(www))/Intranet (internal to 

one network) consists of direct 

transfer from one computing 

system to another. 

Delivery could be via secure 

FTP, HTTP, or other transfer 

protocols. Bandwidth, security, 

and operational deployment 

considerations should be 

addressed. This could enable 

Near Real Time Updates 

[See “Updates”] 

DP Diagnostics - 

User Determined 

Entry to ETM 

Tasking for troubleshooting 

procedures is provided through 

primarily textual references.’ If 

‘statements (if a light is on as 

an example) provide 

alternatives in a narrative form. 

This makes use of a predefined 

fault tree. The user determines 

starting point for maintenance 

action. 

13 Enclosure (2)



DP Diagnostics – 

Software Driven 

Entry to ETM 

The appropriate maintenance 

action starting point is software 

determined through use of an 

inference or logic engine. The 

user is provided with the 

appropriate starting point for 

fault isolation. Various inputs 

from personnel and system and 

multiple fault codes are 

analyzed. The analysis will 

determine if there is a 

relationship between these 

fault codes and information and 

the appropriate action as a 

result. 

DP 

Dynamic 

Diagnostics 

Diagnostic capabilities that use 

on-board monitoring devices 

(e.g. built-in test (BIT) and/or 

support/test equipment to 

provide enhanced capability for 

fault detection and isolation. 

Dynamic diagnostics direct 

fault isolation and 

troubleshooting based on 

results returned from the 

weapon system rather than 

inputs received from the 

maintainer. With this type of 

diagnostics, there are no 

predefined paths in the 

troubleshooting data and the 

paths are generally modelbased. 

Enclosure (2) 14



DP 

Wire/Fluid 

System Tracing 

The capability to select wires, 

fluid, pneumatic, or HVAC line, 

in a diagram or schematic and 

have continuity highlighted 

through the circuit or 

schematic. 

Figure 4. Wire/Fluid System Tracing 

E 

Deficiency 

Report 

Transmittal 

Provides a method for users to 

transmit errors and 

recommended changes to the 

ETMs. Different complexity 

considerations include 

improvement reporting 

tracking, local base collection, 

and management of 

improvement reporting. The 

complexity of this will be 

determined by level of 

integration with the deficiency 

reporting system and the type 

of reporting structure: 

• Paper trail reporting 

• Electronic reporting 

• LAN reporting 

• SATCOM reporting 

15 Enclosure (2)



E 

E 

Maintenance 

Data Collection 

Operator 

Debriefing 

This functionality provides for 

the capability to capture and 

transmit configuration change 

data (i.e. removed and installed 

part number information.) tasks 

authorized, tasks performed, 

results of that work, etc (i.e. 

state table and audit trail). This 

update can feed an external 

data repository or maintenance 

application. 

Includes interface with operator 

and or maintenance debriefing 

system for selecting task 

assignments. Can also include 

development of maintenance 

actions based on operator and 

weapon system inputs. 

E Parts Ordering This functionality is integrated 

with the supply system. 

Linkage is to enable parts 

ordering from within the ETM 

presentation. These links would 

not circumvent the supply 

system. 

E 

Resource 

Scheduling 

Task planning, resource 

allocation, execution, 

monitoring and possibly 

intervention may be 

coordinated among 

cooperating systems by 

multiple human or software 

agents (entities). These agents 

act intelligently against a set of 

constraints to minimize 

conflicts and optimally manage 

the goals of the system users. 

Automatic resource scheduling 

is characteristic of a complex 

autonomic logistics system. 

An engine maintainer’s planned 

maintenance activity may be modified 

from ‘test and repair’ to ‘remove and 

replace’ based on reliability data, mission 

availability requirements, and spares 

availability data from a ship within range. 

Enclosure (2) 16



E Retrieval The ability to request and/or 

collect information from 

sources external to the ETM for 

purposes of enhancing the 

maintenance session. 

Examples are: 

• Supporting technical manuals 

• Supporting technical information 

• Training data and media 

• Engineering source data 

• Parts availability 

• Hazardous material handling 

information 

• Wiring data 

E 

Supporting 

Technical Data 

Includes links to general 

manuals, part and process 

manuals, commodity books, 

etc. Can include links to 

commercial manuals where 

applicable. Further definition is 

required for determining if 

context sensitive linking is 

required or simply calling up an 

instance of the data source. 

System managers must also 

define if linked data sources 

are to be maintained locally, 

networked, or by linking though 

a network and internet/intranet. 

TM specific viewers may be 

needed. 

E Transmittal The ability to provide 

information from the ETM to 

external sources. 

Examples are: 

• Parts ordering 

• Maintenance Management 

systems 

• Training Systems 

• Dynamically update configuration 

data for weapon systems 

• Deficiency reporting 

• Operator Debriefing 

• Flight Performance Module 

• Resource Scheduling 

17 Enclosure (2)



G Locator graphics Locator graphics show where a 

component is located relative 

to other components. 

Fig 6. Locator example 

Fig 7. Component Locator example 

G 

Pan, Zoom, 

Expand, Rotate, 

Magnify 

Controls are provided to 

perform pan, zoom, expand, 

rotate and magnify on graphic 

elements. This is a viewer 

function. 

Fig 8. Pan, Zoom, Expand, Magnify, 

Rotate 

Additional functionality may 

include spyglass view, text 

search, graphics and window 

resizing. 

Consideration should be given 

to the quality or limitations of 

the source data. 

L Hot Reference Capability to display additional 

content such as acronyms, tool 

tips etc. 

For an example, a mouse over the word 

ETM would generate popup text box with 

“Electronic Technical Manual”. 

Enclosure (2) 18



L Hot Spotting Graphics that are enabled with 

links. These can be at various 

levels and include both raster 

and vector based graphics. Hot 

spotting examples include links 

to detail breakouts, next higher 

assemblies, part ordering 

information, parts breakdown 

data, and procedures from 

logic trees. 

Fig 10. Hot spotting 

Example 1 Links to related graphics. Links 

can be to breakdown illustrations showing 

greater detail, next higher assembly, or to 

locator art. 

Example 2 Links to related text. Can 

include links to procedural information 

from a logic or troubleshooting tree. 

L 

L 

Internal 

References 

Link To Separate 

Parts Data 

Internal cross-references are - 

links to related data that can be 

accessed from one view in a 

presentation to another by the 

operator through navigating 

icons or links. Consideration 

must be given for bi-directional 

links. The bi-directional (go 

sub) returns, after completing 

action or procedure, to original 

referenced link. 

Linkage from a maintenance 

task or narrative may be 

provided to a separate parts 

display (illustrated parts 

breakdown/catalog) in the 

current or separate window. 

19 Enclosure (2)



L 

Table of 

contents, Lists of 

Figures, Tables 

and Photos 

These lists allow the user to 

access information presented 

in a procedure graphic (figure), 

table (spreadsheet) or captured 

photo format. This is not 

desirable or practical for ETMs 

where graphics are dynamically 

built. 

This may include a list of 

systems/subsystems and their 

associated tasks, tests, 

descriptive information (theory 

of operation), etc. On some 

implementations, this is the 

"List of Contents." This 

compilation of data will provide 

the total configuration status of 

the data as well as pertinent 

safety information. 

N Audit Trail This functionality provides the 

capability to capture all user 

and ETM interaction. 

Fig. 15. Procedure Checklist 

Fig. 16.Administrative Log 

Enclosure (2) 20



N 

Dialog-driven 

interaction 

A navigational feature that 

allows the user to directly feed 

information to the ETM 

environment. The ETM would 

cue the user to input specific 

data. The feature implies that 

at some point the ETM would 

then respond to the information 

entered. 

Example - During a troubleshooting 

procedure the ETM would open a dialog 

box that states "Enter the voltage reading 

at TP 5". If the user types in 5 (a nominal 

value) the ETM jumps to the next step in 

the procedure. On the other hand if the 

user enters 0 (a fault level reading for a 

short) the ETM might jump to a remove 

and replace procedure. 

N Exit Function to close the IETM 

session. If suspend is used the 

current state tables and 

position in the IETM is 

maintained, otherwise all 

information concerning state 

tables and position is cleared. 

N 

Filter by 

Configuration 

A feature that narrows the 

information presented to the 

user to that associated with a 

specific configuration of the 

end item. In many cases a 

specific end item is changed 

from the baseline configuration 

to a different configuration. 

For example, mission specific equipment 

is added to the weapon systems and 

reflected in the filtered technical data. 

N 

Filter by Model 

Series 


information presented 

appropriate to the specific end 

item maintenance. Such 

filtering may be predefined or 

dynamic, but is usually keyed 

on differences between 

models. 

Example - An “A” model aircraft is a single 

seat configuration. A “B” model aircraft is 

a two-seat configuration. In this example, 

the canopy of each aircraft model is 

physically different. When a technician 

selects the “A” model for viewing, only the 

single seat configuration will be 

presented. 

21 Enclosure (2)



N 

Filter by 

Modification 



appropriate to the specific 

modification rather than the 

end item being modified. A 

user would enter specific 

modification tracking numbers 

and have the data unique to 

that modification presented. 

[See “Access by Model Series”] 

Example 1. TCTO (Time Compliance 

Technical Order) 

Fig 11. Access by Modification 

Example 2. MWO (Modification Work 

Order) 99-0013 upgraded the landing 

gear left support strut from part number 

111500051354-001 to number 

111500051354-003. Filtering by MWO 

number would present the appropriate 

part and maintenance data. 

N 

Filter by Skill/ 

Maintenance 

Level 



appropriate to the specific user 

skill or maintenance level. A 

user id may be the method 

used to access the level of 

proficiency that ETM would 

display. 

N 

Filter by Unique 

Identification 

Code 

This is a navigational filtering 

technique that allows the user 

to display the ETM based on a 

unique identifier such as tail 

number, BUNO, hull number or 

VIN. 

N 

Graphical 

Navigation 

Navigation of the ETM through 

graphical representation of the 

product and its components. 

Provide an intuitive graphical 

interface to enable easy, 

consistent navigation 

throughout the environment. 

(The use of hot spotting is a 

prerequisite) 

Example: From a graphical overview of 

the aircraft system the user selects a 

wing. A graphical overview of the wing is 

presented. The user then selects the 

flaps. A graphical overview of the flaps is 

presented. The user selects the actuator. 

Information on the actuator is presented. 

Enclosure (2) 22



N 

History of 

Traversed Links 


tracks and lists each location 

(link) a user sees along the 

navigational path through an 

ETM. In many cases the user 

has the ability to bring the list 

up and use each location (link) 

in the history list as a link back 

to a point in the path. It 

provides the user a way to 

move forward and backward 

along previously traversed 

links, and a quick way to return 

to a home document. This 

feature is useful when flipping 

back and forth between several 

data types or components of 

the unit under maintenance 

Example - The user opens the ETM to the 

Front Matter (A). Follows the link to the 

section on the landing gear (B). Follows a 

reference link to an adjustment procedure 

(C). The history of traversed links will be 

discretely listed as C. B, A. 

N 

Next and 

Previous 

A navigational function that 

takes the user through a 

procedure in either a sequential 

manner or via a history of 

previous pages. Next displays 

the next data This may be a renavigation 

through previously 

viewed data, with no impact on 

the state information, or a 

progression to the next data in 

the sequence. Previous 

displays the previous viewed 

data (page) with no impact on 

state information, or a reversal 

of steps where state table 

information is modified 

accordingly. 

Example - A user performs steps 1 

through 4 in order. The user is asked a 

branch question in step 4. The user 

answers the question and selects “next”. 

The branch question is evaluated and the 

results are such that user is taken directly 

to step 8. If the user selects “previous” at 

step 8, the user will go to step 7 and not 

to step 4 as would occur if the user 

selected “back” 

N 

Restore Initial 

Navigation View 

A function that returns all 

navigational and other frames 

to their initial view. In some 

ETM implementations, a user 

will have the capability to hide 

navigation or other frames on 

the display. The Restore Initial 

Navigation View functionality 

returns all hidden frames to 

their default positions. The 

ability to initiate the Restore 

Initial Navigation View function 

should always be available to 

the user. 

23 Enclosure (2)



N 

Return 

(Chronological) 

A navigational functionality that 

returns the display to the 

screen view presented 

immediately prior to navigating 

down a sub-branch. This 

functionality could be 

implemented in such a way to 

allow a user to navigate back to 

the start of one or several 

branches or sub-branches. If a 

user executes a link that is not 

an exit link, the Return function 

allows a user to get back to the 

link source from the link 

destination. 

N Search - 

Context 

A feature that allows the user 

to search within an ETM or 

data sources within a particular 

context e.g. parts, steps, 

tables, etc. The data source 

must contain predefined 

context sensitive elements. 

Fig 12. Context Search 

N 

Search - Full 

Text 


allows the user to search for 

any words or phrases within an 

ETM. This feature does not 

depend upon the predefinition 

of key words. 

For example, in searching for “IFF” the 

user may find IFF, difference, TIFF, etc 

depending on the search criteria. 

Enclosure (2) 24



N 

Search - User 

Defined Boolean 

A search feature that permits 

the logical association of terms 

to narrow the results of the 

search by scope (data module, 

ETM, database, etc.). 

Commonly supported logic 

include instances of both x and 

y appear (Logical AND), 

instances where neither x nor y 

appear (Logical NOR), and 

instances where only x or only 

y appear (Logical EXCLUSIVE 

OR). 

N 

Search - Across 

multiple 

databases / files 

A search feature that allows the 

user to look for Key Words 

(assumes common key words) 

or Full Text instances in 

several different data 

collections (i.e. databases). 

N 

Search - Key 

Word 


allows the user to search an 

ETM for occurrences of a 

specific word. System specific 

"key words" are predefined with 

links to their location in the 

data. This provides benefits 

similar to an Index in a paper 

document. Associated 

advanced features might 

include (1) links to the portion 

of the ETM containing the 

word. (2) A “word wheel” that 

narrows the focus of search 

with each letter typed into a 

dialog box. (3) Searches 

across multiple data sources 

[See ”Logical Next and Back”] 

Example - A user might search for the 

term "IFF". The Key Word Search would 

locate each pre-identified occurrence of 

the term in the data This will find all 

occurrences of IFF that have been 

predefined as a key word but not find all 

occurrences of the letters IFF. 

25 Enclosure (2)



N 

Simultaneous 

display of 

multiple content 

elements 

The establishment of a 

necessary relationship between 

content elements (text, tables, 

graphics, etc.) allowing 

simultaneous display. The 

display of either element 

requires the display of the 

other. 

N System / 

Subsystem 

Navigation 

A navigational feature allowing 

the user to follow a top-down 

path through the breakdown 

structure of a system. The 

user follows a physical or 

functional breakdown to the 

next lower assembly and then 

to the next lower assembly 

from that. 

Fig 14. Simultaneous text and graphics 

display. 

Example - A helicopter mechanic might 

begin the navigation of an ETM at the 

helicopter level. Next step would be to go 

down to the airframe. From the airframe, 

the mechanic might pick the cockpit. Next 

subsystem might be the Pilots Seat and 

the final topic might be the forwardrearward 

adjustment. 

N 

Tear off Window 

Capability 

The capability (viewer 

navigation function) to capture 

an image of the existing 

pane/screen and then allow the 

user to navigate forward. This 

provides the capability to 

display the "torn off" image for 

reference. 

Fig 13. Tear off window 

Enclosure (2) 26



N 

User creation of 

bookmarks 


allows the user to flag certain 

locations for later access. It 

allows the user to build their 

own index of links to specific 

locations in the data. 

Associated advanced features 

include login specific 

bookmarks so different people 

using the same presentation 

device have their own unique 

set of bookmarks. This is a 

digital means of implementing 

the dog-eared page, the 

paperclip used in manuals. 

Example - the maintenance crewmember 

that generally does the preventative 

maintenance checks and services might 

have the bookmarks to those tasks. Since 

that crewmember might also do the rotor 

tension adjustment he would also have a 

bookmark to that task. 

N 

Voice-Activated 

Commands 

A feature that enables the user 

to navigate through the ETM by 

pre-determined voice 

commands. The complexity of 

this feature depends upon the 

extent of voice tagging in the 

ETM and the quality of the 

voice recognition software. 

P 

Data Module or 

Element Specific 

Printing 

This capability to print more 

than a screen print is limited to 

a discrete data module or 

element. 

Beyond the printed technical 

data considerations should be 

given to Time/Date stamps, 

destruction notices, destruction 

dates, destruction requirements 

27 Enclosure (2)



P 

Fully 

Formatted/Book 

Version 

This capability provides a 

document printout that 

conforms to a specifically 

called out Document Type 

Definition (DTD). 


data, considerations should be 



dates, and destruction 

requirements. When the 

document exists as an ETM, in 

addition to the cost incurred, 

this will sub-optimize both the 

ETM and the printed Technical 

Manual. 

P Print Linked Data This provides the capability to 

print any linked data on a given 

task/location. This should be 

limited to one level of linking. 

Traversing lower than one layer 

greatly increases the 

complexity. 





dates, destruction requirements 

P Print Screen The print screen capability will 

provide a print of only the 

screen currently being viewed 

by the maintainer. 





dates, destruction 

requirements, security 

markings, associated alerts, 

etc. 

Enclosure (2) 28



S Alerts These elements must be 

readily identified and may 

require specific operator 

acknowledgment prior to 

proceeding with the data being 

presented. When multiple steps 

are involved, an icon should 

identify the condition being 

highlighted and the data should 

be readily available for review 

by activation of the icon. 

Alerts may include Danger, 

Warnings, Cautions, and 

Notes. 

S 

Content 

Sensitive Help 

(Tech Data Help) 

Help information is available to 

the user based on the data 

being presented or the tasks 

being performed through a 

common interface. The type of 

help pertains to the particular 

subject matter of the ETM, 

such as the specific weapon 

system. Content sensitive help 

is delivered through pop-ups, 

dedicated help screens, or pull 

down menus. 

Examples include list of acronyms and 

abbreviations and discrepancy reports 

incorporated. 

S 

Context 

Sensitive Help 

(Viewer Help) 

In many systems, right-clicking 

via the mouse or hovering the 

cursor over a particular graphic 

or menu item will cause a ‘Tool 

tip’ to pop up, providing help or 

a description for the specified 

feature. 

Fig 17. Example of a 'Tool tip' 

S Front Matter Front matter is the prefatory 

information traditionally 

displayed in paper format. The 

complexity, practicality, and 

desirability of front matter 

content varies greatly 

depending on the ETM 

acquired. 

It may include the title information, "A" 

page or change information, verification 

status, export control notice, warning, 

safety summary and the normal table of 

contents information. 

29 Enclosure (2)



S Photos Photos can be included to 

show a specific visual 

representation of actual 

systems. Presentation 

standards (such as resolution, 

file size and file format) must 

be addressed as well as 

content and context of the 

photo. 

S User Training User training complexity can 

range from on-line access 

during ETM run time by linking 

to a CBT database to run 

complete training lessons [See 

“Retrieval and Transmittal”]. 

Capability includes integrating 

or linking maintenance and / or 

operational training on the use 

of the weapon system with the 

ETM. Access of the data can 

be through a link to an external 

module or integrated with the 

ETM. Advanced capabilities 

can be to monitor usage and 

training access for the purpose 

of tracking user competency. 

Specific training courseware 

and or actions are not 

necessarily part of the data. 

U 

Active Change 

Indications and 

markings 

Display and tracking of change 

information can drive costs. In 

Active changes each change is 

discretely marked or identified 

in the ETM. Considerations 

include method of display and 

identification of the change and 

when they are removed or 

suppressed. ETM may include 

a summary of change data. 

U 

Block Cycle with 

Urgent Changes 

Block cycle update means that 

changes from all sources are 

consolidated and issued at 

regularly scheduled intervals. 

Urgent changes are interim 

updates between scheduled 

Block Cycle Updates 

Example: In USAF Rapid Action Changes 

(RACs) are digital change packages that 

are prepared in the same file format as 

the basic TO file for distribution of 

emergency and urgent TO updates. RACs 

are used instead of interim and 

operational supplements. 

Enclosure (2) 30



U Full Revision A full revision is a complete 

replacement of the data 

previously distributed. A Full 

Revision may or may not 

contain detailed change 

markings (or a change 

summary). 

U 

U 

Uo 

Near Real Time 

Updates 

Passive Change 

Indications and 

markings 

Network 

Connectivity 

Updates are available quickly 

to the user after they are 

authorized. This reduction in 

distribution time results in the 

maintainer having more up to 

date data [See “Distribution – 

Network Distribution”] 

Display and tracking of change 

information can drive costs. 

Passive changes are a 

summary of change data and 

are not discretely marked or 

identified in the ETM. 

The end user has access to the 

ETM via a network 

infrastructure. The data can be 

downloaded to or viewed on 

the client device. Device may 

be disconnected and operated 

in a stand-alone mode. The 

Data changes/revisions are 

installed on the host server and 

updates are transmitted via the 

network. [See “Connectivity - 

Update Capability (Full 

Revision and Partial Data)”] 

31 Enclosure (2)



Uo 

Uo 

Uo 

Network 

Connectivity - 

Update 

Capability 

(Partial) 

Network 

Connectivity - 

Context Filtering 

Network 

Connectivity 

Mode - Update 

Capability (Full 

Revision) 







in a stand-alone mode. This 

capability entails the update of 

the data via network 

distribution that contain only 

the changed information from 

the previously release. 

Downloading the data to the 

user's e-tool is done via the 

network. 

This method is a viable 

approach but is still technically 

difficult to do. 







in a stand-alone mode. When 

connected to a network, the 

configuration of the weapon 

system may be readily 

available to the e-tool via a 

maintenance management 

system. The configuration can 

then be "loaded" to the e-tool 

for ETM use. 







in a stand-alone mode. Data 

revisions are installed on the 

host server and updates are 

transmitted via the network. 

This is the least cost method of 

updates. 

Enclosure (2) 32



Uo 

Uo 

Uo 

Uo 

Stand Alone 

Mode 

Stand Alone 

Mode - Context 

Filtering 

Stand Alone 

Mode - Update 

Capability (Full 

Revision) 

Stand Alone 

Mode - Update 

Capability 

(Partial) 

The end user is either 

accessing the ETM via the hard 

drive or CDROM/DVD. 

Consideration should be taken 

for the update capabilities. [See 

“Stand Alone Mode - Update 

Capability (Full Revision and 

Partial Data)”] 

When in Stand Alone Mode, 

the configuration of the weapon 

system may not be readily 

available on the e-tool. If 

connected to a maintenance 

management system, the 

configuration can be "loaded" 

to the e-tool prior to 

disconnection and ETM use. 

Without a configuration file, the 

user will be required to answer 

dialogs (questions) that 

normally would not be asked in 

a network connection mode. 

This capability entails the 

update of the data via a entire 

CDROM/DVD distribution. This 

is done via reading the new 

distribution or downloading the 

data from the CDROM/DVD to 

the user's e-tool hard drive. 

This method provides the 

lowest cost impact. 

This capability entails the 

update of the data via 

CDROM/DVD distribution that 

contains only the changed 

information from the previous 

release. This is difficult to 

implement if the stand-alone 

mode is designed to view from 

the CDROM/DVD. 

Downloading the data from the 

CDROM/DVD to the user's e- 

tool hard drive is a viable 

approach but is still technically 

difficult to do. 

33 Enclosure (2)



Uo 

Web Browser 

Viewable 


ETM to be viewed through a 

COTS web browser. This may 

be accomplished directly 

through the web browser or 

through helper applications 

(e.g. Adobe Acrobat) or plugins 

(e.g. IsoView). 

NOTE: The functionality selected in this 

matrix will determine the level of 

complexity and cost of implementing a 

web browser viewable application. 

Consideration will be required 

for a specific web browser. 

Different implementations 

include remote access to an 

ETM web server, opening static 

HTML pages locally, and web 

server emulation on the client 

viewer. 

Enclosure (2) 34


Glossary of Terms and Acronyms 

Autonomic logistics – A system that acts without human 

intervention and consists of two primary components: a 

Prognostics and Health Management System and a Joint Distributed 

Information System. The Prognostics and Health Management System 

collects information while the weapon system is in operation 

using sensors and diagnostics to detect faults and impending 

faults. Reasoning algorithms are used to determine the causes of 

the faults. The system detects degrading performance and thus can 

forecast the requirement to replace a component prior to its 

predicted failure. The Joint Distributed Information System 

communicates this information immediately through the logistics 

infrastructure, automatically acquiring the spare parts, tools, 

and manpower 

Bookmark - A navigational feature that allows the user to flag 

certain locations for later access. It allows users to build 

their own index of links to specific locations in the data. 

BUNO - Bureau Number 

Change - Changes vary in size from a single character 

modification to a complete rewrite of the data including all 

associated text and graphics and anywhere in between. Changes can 

be identified at the step, task, or chapter level. Changes can 

take many different paths and time frames such as periodic 

changes (planned by the calendar or block), and rapid action 

changes (emergencies, urgent action changes, etc.). Changes may 

or may not be discretely identified to the operator so that 

"what’s different" can be conveyed. 

Data module - A self-contained unit of data for the description, 

operation, identification of parts or maintenance of an air 

vehicle, airborne engine, airborne equipment and support 

equipment. The unit of data consists of an Identification and 

Status section and Contents section and is produced in such a 

form that it can be input into, and retrieved from, a database 

using the data module code as the identifier. 

Delivery – The method of moving tech data from a contracted 

vendor to the contracted client. 

Distribution – The method of moving tech data from an initial 

point to all the end users of the tech data. 

Diagnostics – Maintenance procedures that result in the 

identification of a repair; troubleshooting. May or may not be 

assisted with hardware/software tools. 

35 Enclosure (2)


Dialog box - A method for an IETM to request and receive input 

from the user. It is a separate window that displays a request 

and includes an area to input a response. 

Drilling down – The process of navigating from broader focused 

content to more specific and detailed content. 

Element – A single discrete item in an ETM environment. 

ETM – Electronic Technical Manual 

E-tool – An electronic device used for displaying tech data. 

Filtering – A process that narrows the displayed data to show 

only a specific and desired sub-set of data. As an example, the 

complete technical data for an aircraft can be filtered to only 

display to the user the data that applies to a requested tailnumber. 

Fly through – A virtual three-dimensional navigation of a solid 

object. The user has the ability to control the perspective, 

direction and location of the displayed view of an object. The 

user also has the ability to virtually move through the object by 

dynamically changing the perspective, direction and location of 

the display. 

Hot reference – A link to another location. A hot reference can 

be textual or graphical. 

Human factor issues – An area of study concerned with the 

interaction between humans and computers. Includes efforts to 

most effectively design software interfaces to be most easily 

understood and efficiently used. 

IETM – Interactive Electronic Technical Manual 

Inference engine – A computer program that, based on user or 

other input, determines the correct sequence to display 

technical data in an IETM (also called a logic engine). 

LAN – Local Area Network 

Legacy TM – A technical Manual developed to meet standards that 

have now been superceded by newer standards. 

Linear – Tech Data that is displayed in a linear or document 

oriented manner. The data author largely predefines the 

sequence of the data presentation. It is an organization of 

tech data that replicates the order of information found in a 

page-based document. There is generally one primary “path” 

through the tech data. 

Linking – The connection of two locations in a document to form a 

cross-reference. 

Enclosure (2) 36


Logic engine – A computer program that, based on user or other 

input, determines the correct sequence to display technical data 

in an IETM (also called an inference engine). 

Maintenance action – A specific and self-contained maintenance 

process to be completed by a tech data user. Multiple 

maintenance actions may be completed in the course of a single 

maintenance session. 

Maintenance session – The sum of all maintenance actions 

completed during a single user’s shift while keeping an IETM open 

and active. 

MWO – Modification Work Order 

Navigation – The act of traversing through tech data. 

Navigation may be accomplished via software inherent items (next 

and back buttons) or through tech data inherent items (links). 

Near real time – Access to updated data at or near the time of 

content approval and posting. Network connectivity is required 

to achieve near real time access to data. 

Non-linear – Tech Data that is displayed in a non-linear fashion. 

There are high levels of interactivity between the data and the 

user. The sequence of presentation is dictated by inputs by the 

user, external sources or events (as in diagnostics). An 

organization of content that does not follow a document or page 

based paradigm. There are multiple paths through the data. 

Individual paths through the data are generally determined based 

on user or other input via dialog boxes. 

Online environment – The virtual environment contained within a 

computer and its connected (networked) devices. 

PDA – Personal Digital Assistant. It is a hand-held electronic 

device capable of displaying ETMs. 

Persistent annotations – Annotations that are captured and 

retained for later use. 

Point and click – The functionality of selecting a process (like 

a link) by use of a mouse or other input device. 

Prognostics – Procedures that focus on preventative maintenance 

and care of equipment. May include health monitoring and linkage 

to autonomic logistics systems. 

SATCOM – Satellite Communications 

Search – A navigational method to locate and display desired 

information via the use of processes that match results to user 

requests. 

37 Enclosure (2)


Sustainment – The processes and actions required to maintain 

technical data over its lifecycle. 

TCTO – Time Compliant Technical Order. A technical order with 

required actions and mandated completion dates. 

Tool tip – A small pop up that appears and contains helpful 

information. Moving the mouse over a preprogrammed element 

generally activates a tool tip. 

touch screen – A device that allows the user to provide input to 

the ETM by touching the display screen. 

Tracking – The process of monitoring and retaining information 

about the navigational activities of a particular user or 

device. 

Traverse – The process of navigating through an electronic 

document. 

Updates – Changes to an electronic document. 

User session – The cumulative ETM-related activities of a single 

user from the point when the ETM use begins to the point when it 

ends uninterrupted by log-offs. A user session can be 

maintained by suspend/restart functionality. 

Enclosure (2) 38

THIS PAGE INTENTIONALLY LEFT BLANK


NOT MEASUREMENT 

SENSITIVE 

NAVAIR INTERACTIVE ELECTRONIC TECHNICAL MANUALS 

(IETM) COMMON LOOK AND FEEL REQUIREMENTS 

Do not cite this document as a requirement 

Enclosure (4)


CONTENTS 

1. SCOPE ........................................................ 1 

1.1 Scope ..................................................... 1 

1.2 Applicability ............................................. 1 

2. APPLICABLE DOCUMENTS ......................................... 1 

2.1 General ................................................... 1 

2.2 Government documents ...................................... 1 

2.2.1 Specifications, standards, and handbooks ................. 1 

2.2.2 Other Government documents and publications .............. 2 

2.3 Non-Government publications ............................... 3 

2.4 Order of precedence ....................................... 4 

3. DEFINITIONS .................................................. 4 

4. GENERAL GUIDANCE ............................................ 11 

4.1 General .................................................. 11 

4.1.1 Integrated Data Environment (IDE)....................... 11 

4.1.2 IETM acquisition choices ................................ 11 

4.1.3 IETM acquisition considerations ......................... 11 

4.1.3.1 Resources ............................................. 11 

4.1.3.2 Purpose and goal ...................................... 12 

4.2 Determining IETM functionality ........................... 12 

5. VIEWER COMPONENTS .......................................... 12 

5.1 Overview ................................................. 12 

5.2 Available viewers ........................................ 12 

5.3 Outer shell .............................................. 12 

5.4 Inner shell .............................................. 12 

5.5 General screen ........................................... 13 

5.6 Guide post functions ..................................... 14 

5.6.1 Guide post .............................................. 15 

5.6.2 Toggled off functions ................................... 15 

5.6.3 Toggled on functions .................................... 16 

5.7 Additional functions ..................................... 16 

5.8 Drill up/drill down ...................................... 16 

5.9 Table of Contents (TOC).................................. 16 

5.10 Classification bar ....................................... 17 

5.11 Navigation panel ......................................... 17 

5.12 Subtitle bar ............................................. 17 

5.13 Main menu bar ............................................ 17 

5.14 Project specific bar ..................................... 18 

5.15 Main content area ........................................ 18 

5.16 Status bar ............................................... 18 

5.17 Screen sizes ............................................. 18 

6. MAINTAINING A COMMON LOOK-AND-FEEL AMONG DIFFERING IETMs .... 18 

Enclosure (4) 

ii

CONTENTS NAVAIR INST 4120.11 

6.1 Overview ................................................. 18 

6.2 Joint NAVAIR/Industry user-interaction requirements ...... 19 

6.2.1 Joint-Service IETM technology ........................... 19 

6.2.2 Contract guidelines ..................................... 19 

6.3 Preliminary user-interaction guidelines for NAVAIR IETMs . 19 

6.3.1 ... Display format (text/font, graphic, table, lists, object 

embedding) .................................................... 19 

6.3.2 ... Browse capability. Browse capability should be available 

20 

6.3.3 Link behavior/navigation ................................ 20 

6.3.4 Control bars ............................................ 20 

6.3.5 Icon standardization .................................... 20 

6.3.6 Warnings, cautions and notes ............................ 23 

6.3.7 Search and lookup ....................................... 23 

6.3.8 Session control (suspends, resume and nested sessions) .. 24 

6.3.9 Context filtering ....................................... 24 

6.3.10 Screen resolution and color guidelines ................. 24 

6.3.11 Information access (indices, electronic TOCs, etc.) .... 24 

6.3.12 Dialogs ................................................ 25 

6.3.13 Sound (optional)....................................... 25 

6.3.14 Voice input/output (I/O) (optional).................... 25 

6.3.15 Graphics ............................................... 25 

6.3.16 Hardware user interface ................................ 25 

6.3.17 Performance (response time by context) ................. 26 

6.3.18 Printer output ......................................... 26 

6.3.19 User annotations ....................................... 26 

6.3.20 Feedback to originator ................................. 26 

6.3.21 Administrative information ............................. 27 

6.3.22 Interface to external references and systems ........... 27 

6.3.23 Rapid action changes/critical safety interim messages .. 27 

7. IETM FORMATTING GUIDELINES .................................. 27 

7.1 Use of a style sheet ..................................... 22 

7.2 Display of text .......................................... 27 

7.2.1 Character font .......................................... 28 

7.2.2 Character spacing ....................................... 28 

7.2.3 Line dimensions ......................................... 28 

7.2.4 Text panes .............................................. 28 

7.3 Margins .................................................. 29 

7.4 Justification ............................................ 29 

7.5 Word wrapping ............................................ 29 

7.6 Hyphenation .............................................. 29 

7.7 Tables ................................................... 29 

7.7.1 Display of tables ....................................... 29 

7.7.2 Justification ........................................... 29 

7.7.3 Column spacing .......................................... 29 

7.7.4 Row spacing ............................................. 29 

iii Enclosure (4)


CONTENTS 

7.8 Graphics ................................................. 29 

7.8.1 Display of graphic overlays ............................. 29 

7.8.2 Types of graphics ....................................... 29 

7.8.3 Scale ................................................... 30 

7.8.4 Display ................................................. 30 

8. IETM AUTHORING GUIDELINES ................................... 30 

8.1 Authoring style guidelines for IETMs ..................... 30 

9. NOTES ....................................................... 31 

9.1 Intended use ............................................. 31 

APPENDIX A IETM GENERAL CONTENT GUIDANCE ...................... 32 

A.1 SCOPE ....................................................... 32 

A.1.1 Scope ................................................... 32 

A.1.2 Philosophy .............................................. 32 

A.2 APPLICABLE DOCUMENTS ........................................ 32 

A.3 DEFINITIONS ................................................. 32 

A.3.1 Acronyms used in Appendix A ............................. 32 

A.3.2 Annotations ............................................. 33 

A.3.3 Audit trails ............................................ 34 

A.3.4 Autonomic logistics ..................................... 34 

A.3.5 Bookmark ................................................ 34 

A.3.6 Cascading menus ......................................... 34 

A.3.7 Context filtering ....................................... 34 

A.3.8 Delivery ................................................ 34 

A.3.9 Dialogs ................................................. 34 

A.3.10 Diagnostics ............................................ 34 

A.3.11 Dialog box ............................................. 35 

A.3.12 Distribution ........................................... 35 

A.3.13 Drilling down .......................................... 35 

A.3.14 Effectivity ............................................ 35 

A.3.15 Element ................................................ 35 

A.3.16 Embedded ............................................... 35 

A.3.17 E-tool ................................................. 35 

A.3.18 Filtering .............................................. 35 

A.3.19 Fly through ............................................ 35 

A.3.20 Frame-based IETM ....................................... 35 

A.3.21 Guide post ............................................. 35 

A.3.22 Hot reference .......................................... 36 

A.3.23 Hot spot ............................................... 36 

A.3.24 Human factor issues .................................... 36 

A.3.25 Inference engine ....................................... 36 

A.3.26 In-line ................................................ 36 

A.3.27 Inner shell ............................................ 36 

A.3.28 Legacy TM .............................................. 36 

A.3.29 Linking ................................................ 36 

A.3.30 Logic engine ........................................... 36 

Enclosure (4) 

iv


A.3.31 Maintenance session .................................... 36 

A.3.32 Navigation ............................................. 36 

A.3.33 Near real time ......................................... 36 

A.3.34 Online environment ..................................... 37 

A.3.35 Outer shell ............................................ 37 

A.3.36 Pane ................................................... 37 

A.3.37 PDA .................................................... 37 

A.3.38 Persistent annotations ................................. 37 

A.3.39 Point and click ........................................ 37 

A.3.40 Pop-up menus ........................................... 37 

A.3.41 Prognostics ............................................ 37 

A.3.42 SATCOM ................................................. 37 

A.3.43 Scrollable Frame IETMs ................................. 37 

A.3.44 Scrollable IETMs ....................................... 37 

A.3.45 Screen stacking ........................................ 38 

A.3.46 Search ................................................. 38 

A.3.47 Session control ........................................ 38 

A.3.48 Sustainment ............................................ 38 

A.3.49 Tool tip ............................................... 38 

A.3.50 Touch screen ........................................... 38 

A.3.51 Tracking ............................................... 38 

A.3.52 Traverse ............................................... 38 

A.3.53 User navigation panel .................................. 38 

A.4 GENERAL CONTENT GUIDELINES .................................. 38 

A.4.1 General ................................................. 38 

A.4.2 Abbreviations and acronyms .............................. 39 

A.4.3 Security classification and protective markings ......... 39 

A.4.4 Style and format requirements for technical content ..... 39 

A.4.5 IETM divisions .......................................... 40 

A.4.6 Parts information ....................................... 40 

A.4.7 Referencing ............................................. 40 

A.4.7.1 Other documents ....................................... 40 

A.4.7.2 Government specifications and standards ............... 40 

A.4.7.3 Within the IETM ....................................... 40 

A.4.7.4 Equipment, components, and parts ...................... 40 

A.4.7.5 National Stock Numbers (NSNs) and Part Numbers (P/Ns). 40 

A.4.7.6 Equipment panel markings (placarding)................. 41 

A.4.7.7 Metric and U.S. standard measurements ................. 41 

A.4.7.8 Temperature ........................................... 41 

A.4.7.9 Other IETMs ........................................... 41 

A.4.7.10 Tables ............................................... 41 

A.4.7.11 Figures .............................................. 41 

A.4.7.12 Index numbers ........................................ 41 

A.4.7.13 Items on diagrams .................................... 41 

A.4.8 Multimedia presentation ................................. 42 

A.4.9 Portraying signal flow .................................. 42 

v Enclosure (4)


CONTENTS 

A.4.10 Color in illustrations ................................. 42 

A.4.11 Revisions for IETMs .................................... 42 

A.4.12 Revision symbols ....................................... 42 

A.4.13 Revision symbols for illustrations Unless specified 

otherwise by the acquiring activity, a miniature pointing hand 

should be used for illustrations (other than diagrams and 

schematics) to highlight the area containing the revised 

information ................................................... 43 

A.4.14 Style guidelines ....................................... 43 

A.4.15 Format guidelines ...................................... 43 

A.4.16 User interaction and features .......................... 44 

A.4.16.1 General user interaction ............................. 44 

A.4.17 Graphic guidelines ..................................... 44 

A.4.18 Graphic display ........................................ 44 

A.4.19 Display characteristics/colors ......................... 44 

A.4.20 Text colors / background ............................... 44 

A.4.21 Standard text/fonts .................................... 44 

A.4.22 Front and rear matter .................................. 45 

A.4.23 Revision summaries ..................................... 45 

A.4.23.1 Revision markings .................................... 45 

A.4.24 Hot spots/links ........................................ 45 

A.4.24.1 Text links ........................................... 45 

A.4.24.2 Hotspots in graphics ................................. 45 

A.4.24.3 Hot spots in tables .................................. 46 

A.4.24.4 Links to graphics and tables ......................... 46 

A.4.24.5 Links to multimedia .................................. 46 

A.4.25 User interface ......................................... 46 

A.4.25.1 Session control ...................................... 46 

A.4.25.2 Bookmarks and annotations ............................ 47 

APPENDIX B EXAMPLE IETM CONOPS LAYOUT ......................... 49 

B.1 SYSTEM INTRODUCTION ......................................... 49 

B.2 SYSTEM ATTRIBUTES ........................................... 49 

B.2.1 Complexity of System .................................... 49 

B.2.2 Configuration Volatility ................................ 49 

B.2.3 Classification and Security ............................. 49 

B.2.4 Expected Service Life ................................... 49 

B.2.5 Number and Deployment Systems ........................... 49 

B.2.6 Number of IETM Users .................................... 49 

B.2.7 Quantity of Data ........................................ 49 

B.2.8 Quality of Data ......................................... 49 

B.2.9 Consolidation of Subject Matter ......................... 49 

B.2.10 Maintenance Levels ..................................... 50 

B.2.11 Training Levels ........................................ 50 

B.2.12 Manning Requirements ................................... 50 

B.2.13 Existing Government and Contractor Infrastructure ...... 50 

B.2.14 IETM Implementation Schedule ........................... 50 

Enclosure (4) 

vi


B.2.15 Urgency of Information Update .......................... 50 

B.2.16 Security ............................................... 50 

B.2.17 Display Hardware, Operating Systems, Networks and 

Compatibility ................................................. 50 

B.2.18 Environmental Conditions and IETM Display Hardware ..... 50 

B.2.19 Display Hardware maintenance and Support ............... 51 

FIGURE 1. Example of inner and outer shell. ................ ………13 

FIGURE 2. Example of inner shell. ............................. 15 

vii Enclosure (4)

THIS PAGE INTENTIONALLY LEFT BLANK


1. SCOPE. 

1.1 . Scope. These guidelines are non-regulatory and provide 

guidance and information for the use of Common Look and Feel in 

the development of frame-based IETMs. The requirements set 

forth in this document assume that the data is in SGML/XML 

format and are intended to provide more specific direction to 

IETM developers in order to obtain consistency for IETMs across 

NAVAIR. 

1.2 . Applicability. These requirements are applicable for use by 

NAVAIR and supporting contractors. 

2. APPLICABLE DOCUMENTS. 

2.1 . General. The documents listed below are not necessarily all 

the documents referenced herein, but are the ones that are 

needed in order to fully understand the information provided 

within. 

2.2 . Government documents. 

2.2.1 . Specifications, standards, and handbooks. The following 

specifications, standards, and handbooks form a part of this 

document to the extent specified herein. Unless otherwise 

specified, the issues of these documents are those listed in the 

latest issue of the Department of Defense Index of 

Specifications and Standards (DODISS) and supplemented thereto, 

and are referenced for guidance only. 

SPECIFICATIONS 

STANDARDS 

DEPARTMENT OF DEFENSE 

MIL-PRF-28000 

— 

Digital Representation for 

Communication of Product Data: IGES 

Application Subsets and IGES 

Application Protocols. 

MIL-PRF-28001 — Markup Requirements and Generic Style 

Specification for Exchange of Text and 

Its Presentation. 

MIL-PRF-28002 — Raster Graphics Representation in 

Binary Format, Requirements for. 

MIL-PRF-28003 — Digital Representation for 

Communication of Illustration Data: 

CGM Application Profile 

1 Enclosure (4)



HANDBOOKS 

MIL-STD-100 — Engineering Drawing Practices. 

MIL-STD-1309 — Definition of Terms for Testing, 

Measurement, and Diagnostics. 

MIL-STD-3001-1 — Preparation of Digital Technical 

Information for Multi-output 

Presentation of Technical Manuals. 

MIL-STD-2361 — Digital Publications Development 

MIL-STD-40051-1 — Preparation of Digital Technical 

Information for Interactive Electronic 

Technical Manuals (IETMs) 


MIL-HDBK-511 — Interoperability of Interactive 

Electronic Technical manuals (IETMs) 

MIL-HDBK-9660 — Handbook for DoD-Produced CD-ROM 

Products 

(Copies of these documents are available online at 

http://assist.daps.dla.mil/quicksearch/ or www.dodssp.daps.mil 

or from the Standardization Document Order Desk, 700 Robbins 

Avenue, Building 4D, Philadelphia, PA 19111-5094.) 

2.2.2 . Other Government documents and publications. The following 

other Government documents and publications form a part of these 

requirements to the extent specified herein. 

EO12196 — Occupational, Safety and Health 

Programs for Federal Employees. 

EO12958 — Classified National Security 

Information 

(Copies of directives and instructions are available by request 

to Commander, Naval Inventory Control Point Philadelphia, 

Publications/Forms Branch, Code 03334, 700 Robbins Avenue, 

Philadelphia, PA 19111-5098.) 

DOD 5200.1-R — Information Security Program 

Joint Pub 1-02 — DOD Dictionary of Military and 

Associated Terms 

Enclosure (4) 2


(Copies of DOD 5200.1-R and Joint Pub 1-02 are available from 

the National Technical Information Service. U.S. Department of 

Commerce, 5285 Port Royal Road, Springfield, VA 22161.) 

DOD 5220.22-M — National Industrial Security 

Program for Operating Manual 

Library of 

Congress 

Catalog No. 

Z253.U58 

Public Law 91- 

596 

— U.S. Government Printing Office 

(GPO) Style Manual 

— Occupational Safety and Health 

Act, dated December 29, 1970 and 

Executive Order 11807 

(Copies of the DOD 5220.22-M and GPO Style Guide are available 

from the U.S. Government Printing Office, ATTN: Superintendent 

of Documents, Washington, DC 20402-0001.) 

2.3 . Non-Government publications. The following documents form a 

part of this document to the extent specified therein. Unless 

otherwise specified, the issues of the documents that are DOD 

adopted are those listed in the latest issue of the DODISS, and 

supplement thereto. 

AMERICAN NATIONAL STANDARDS INSTITUTE (ANSI) 

ISO 8879 — Information Processing - Text and 

Office Systems - Standard Generalized 

Markup Language — (SGML) 

(Copies of the documents listed above are available from the 

American National Standards Institute Inc., 1430 Broadway, New 

York, NY 10018-3308.) 

WORLD WIDE WEB CONSORTIUM (W3C) 

REC–xml– 

20001006 

REC–xslt– 

19991116 

REC-xpath- 

19991116 

REC-xsl- 

20011015 

— Extensible Markup Language (XML) 

1.0 (Second Edition) 

— XSL Transformations (XSLT) Version 

1.0 

— XML Path Language (XPath) Version 

1.0 

— Extensible Stylesheet Language 

(XSL) 

Version 1.0 

REC-xlink- — XML Linking Language (XLink) 

3 Enclosure (4)


20010627 Version 1.0 

(Copies of these publications are available from World Wide Web 

Consortium (W3C) should be obtained from the Internet address 

http://www.w3.org.) 

2.4 . Order of precedence. In the event of a conflict between the 

text of this document and the references cited herein, the text 

of the referenced document takes precedence. Nothing in this 

document, however, supersedes applicable laws and regulations 

unless a specific exemption has been obtained. 

3. DEFINITIONS. 

3.1 . Acronyms used in this policy. The acronyms used in this 

policy are defined as follows: 

ASCII 

AMSC 

ANSI 

CALS 

CCSS 

CD-ROM 

CGM 

DOD 

DODISS 

DTD 

EDS 

ETM 

IEEE 

IETM 

IGES 

IPR 

ISO 

JIA 

JPEG 

JTCI 

NMWR 

OS 

PDA 

PDF 

PNG 

QA 

SGML 

American Standard Code for Information 

Interchange 

Acquisition Management System Control 

American National Standards Institute 

Continuous Acquisition and Life-cycle Support 

Commodity Command Standard System 

Compact Disk - Read Only Mode 

Computer Graphics Metafile 

Department of Defense 

Department of Defense Index of Specifications 

and Standards 

Document Type Definition 

Electronic Display System 

Electronic Technical Manual 

Institute of Electrical and Electronics 

Engineers 

Interactive Electronic Technical Manual 

Initial Graphics Exchange Specification 

In-Process Review 

International Organization for Standardization 

Joint IETM Architecture 

Joint Photographers Experts Group 

Joint Technical Committee for Information 

National Maintenance Work Requirement 

Output Specification 

Personal Digital Assistant 

Portable Document Format 

Portable Network Graphics 

Quality Assurance 

Standard Generalized Markup Language 

Enclosure (4) 4


TM 

TMQA 

TMSS 

TPDR 

WYSIWYG 

W3C 

XML 

XLink 

XPath 

XSL 

XSLT 

Technical Manual 

Technical Manual Quality Assurance 

Technical Manuals Specifications and Standards 

Technical Publication Discrepancy Report 

What You See is What You Get 

World Wide Web Consortium 

Extensible Markup Language 

XML Linking Language 

XML Path Language 

XML Style sheet Language 

XSL Transformations 

3.2 . Definitions of selected terms. 

3.2.1. Annotations. Annotations are the ability of the IETM 

author and or user to place special notes within an IETM. These 

notes can be public information for all users, such as special 

information that requires rapid deployment to the IETM holders 

(e.g., “Advance Change Notices”). They also can be private 

notes needed only by the user to assist in their training or in 

the performance of their duties. 

3.2.2 . Acquiring activity. The DOD component, activity, or 

organization of a using military service, or that organization 

delegated by a using service that is responsible for the 

selection and determination of requirements for TMs. 

3.2.3 . American National Standards Institute (ANSI). A private 

sector organization, which plans, develops, establishes or 

coordinates standards, specifications, handbooks or related 

documents. 

3.2.4 . Bookmark. Bookmarks are the capability to mark areas of 

interest to allow quick access within an IETM. 

3.2.5 . Cascading menus. A cascading menu is the child of the 

first menu item selected. In both the drop-down menu format and 

the pop-up menu format, the child menu appears next to the first 

menu item selected. There may be several levels of cascading 

menus. 

3.2.6 . Callout. Anything placed on an illustration to aid in 

identifying the objects being illustrated, such as index 

numbers, nomenclature, leader lines, and arrows. 

3.2.7 . Caution. A statement or some other notification about an 

operating or maintenance procedure, practice, or condition that, 

if not strictly observed, could result in damage to, or 

destruction of, equipment or loss of mission effectiveness. 

5 Enclosure (4)


3.2.8 . Change. A change is comprised of corrected pages/work 

packages to the basic manual (or previous edition). It consists 

of information that improves or clarifies the manual without 

requiring rewriting or reorganization of the technical content 

of the manual. 

3.2.9 . Comprehensibility. The completeness with which a user in 

the target audience understands the information in the TM. 

3.2.10 . Computer Graphics Metafile (CGM). A standard digital form 

for graphics preparation. Defined by MIL-PRF-28003. 

3.2.11 . Context filtering. Context filtering is when the 

presentation system automatically displays the relevant 

information applicable to the existing situation. For an 

example, only a specific piping system would be displayed in a 

compartment diagram or the level of instructions would be 

filtered based on the users level of ability (novice vice 

expert). 

3.2.12 . Continuous Acquisition Life-cycle Support (CALS). A DOD 

initiative to transition from paper-intensive, non-integrated 

weapon systems design, manufacturing, and support processes to a 

highly automated and integrated mode of operation. This 

transition will be facilitated by acquiring, managing, and using 

technical data in standardized digital form. 

3.2.13 . Continuous Acquisition Life-Cycle Support (CALS) raster. 

Compressed scanned raster images (CCITT, Group 4) in accordance 

with MIL-PRF-28002. 

3.2.14 . Continuous tone photographs or drawings. Continuous tone 

photographs or drawings have a continuous gradation of tonal 

values ranging from light (white) to dark (black), including 

gray. 

3.2.15 . Department of Defense (DOD). The Office of the Secretary 

of Defense (OSD) (including all boards and councils), the 

Military Departments (Army, Navy, and Air Force), the 

Organization of the Joint Chiefs of Staff (OJCS), the Unified 

and Specified Commands, the National Security Agency (NSA), and 

the Defense Agencies. 

3.2.16 . Department of Defense Index of Specifications and 

Standards (DODISS). The DOD publication that lists unclassified 

Federal and military specifications and standards, related 

standardization documents, and voluntary standards approved for 

use by DOD. 

3.2.17 . Depot-level maintenance. Maintenance that is beyond the 

capability of the unit, direct support, and general support 

Enclosure (4) 6


activities. Depot-level maintenance normally consists of 

overhaul, recondition, manufacture, repair, or modification and 

requires technical assistance beyond lower maintenance level 

capability. 

3.2.18 . Dialogs. Dialogs are the pop-ups and in-line collection 

mechanisms for gathering information for the IETM from the user. 

3.2.19 . Digital graphics forms. A standard graphics form 

acceptable for graphics preparation in accordance with graphic 

standards listed in MIL-STD-40051. These forms include CGM, 

CALS raster, and Initial Graphics Exchange Specification (IGES), 

Joint Photographers Experts Group (JPEG) and Portable Network 

Graphics (PNG). 

3.2.20 . Document Type Definition (DTD). The definition of the 

markup rules for a given class of documents. A DTD or reference 

to one should be contained in any XML conforming document. 

3.2.21 . Extensible Markup Language (XML). A subset of SGML. It 

enables generic SGML to be served, received, and processed on 

the Web in the way that is now possible with HTML. XML has been 

designed for ease of implementation and for interoperability 

with both SGML and HTML. 

3.2.22 . Frame-based technical manual. The format and style of the 

presented information are optimized for window presentation to 

assure maximum comprehension. The presentation format is 

"frame-oriented" and not "page oriented". 

3.2.23 . Functional diagram. A type of illustration in which 

symbols are connected by lines to show relationships among the 

symbols. The symbols may be rectangles or other shapes, 

standard electronic symbols representing components or 

functions, or pictorials representing equipment or components. 

Where appropriate, voltage readings are shown. The lines may 

represent procedures or processes, such as signal or logic flow, 

and physical items, such as wires. Functional diagram includes 

schematics, wiring and piping diagrams, logic diagrams, flow 

charts, and block diagrams. 

3.2.24 . Guide post. The Guide Post is the part of the User 

Navigation Panel that allows the user to get to and initiate 

special advanced functions or to return to the standard default 

ribbon bar. 

3.2.25 . Graphic(s). Any type of presentation or representation, 

which gives a clear visual impression. 

7 Enclosure (4)


3.2.26 . Halftones. Halftones are the tonal values of gray and 

black created by lines or dots. It is a conversion of a 

continuous tone print. 

3.2.27 . Horizontal (landscape) TM format. Positioning of 

technical manual so that page horizontal (width) dimensions are 

greater than vertical (height) dimensions. 

3.2.28 . Icon. Pictorial representation; visual image to give 

immediate recognition of a hazard or to provide essential 

information. 

3.2.29 . Illustration. A general term meaning graphic 

presentations of all types. Illustrations include pictorials, 

functional diagrams, and line graphs. This term is used instead 

of such terms as figure, graphic, drawing, diagram, and artwork. 

3.2.30 . Index numbers and letters. A number or letter (on a 

figure or an illustration) usually attached to a line or an 

arrow which points to an object on the illustration. This 

number or letter corresponds to the same number or letter in a 

legend or text, which defines or identifies the object in the 

illustration. 

3.2.31 . Initial Graphics Exchange Specification (IGES). A 

standard digital form for graphics preparation. Defined by 

MIL-PRF-28000. 

3.2.32 . Inner shell. The Inner Shell is the portion of the IETM, 

within the browser shell, provided as the client application 

display area. This is the only portion of the screen real 

estate under the developer’s control. 

3.2.33 . Institute of Electrical and Electronics Engineers (IEEE). 

Membership organization that includes engineers, scientists and 

students in electronics and allied fields. Founded in 1963, it 

has over 300,000 members and is involved with setting standards 

for computers and communications. 

3.2.34 . Interactive Electronic Technical Manual (IETM). A 

technical manual prepared in digital form and designed for 

interactive display to the maintenance technicians or system 

operator end users by means of a computer controlled Electronic 

Display System (EDS). 

3.2.35 . International Organization for Standardization (ISO). 

Organization that sets international standards, founded in 1946 

and headquartered in Geneva. It deals with all fields except 

electrical and electronics, which is governed by the older 

International Electrotechnical Commission (IEC), also in Geneva. 

Enclosure (4) 8


With regard to information processing, ISO and IEC created JTC1, 

the Joint Technical Committee for information technology. 

3.2.36 . Joint Photographers Experts Group (JPEG). JPEG is a file 

format for the transport of single JPEG compressed image. The 

JPEG compression format was standardized by ISO in August 1990. 

JPEG images are widely used on the Web. 

3.2.37 . Legend. A tabular listing and explanation of the numbers 

or symbols on a figure or an illustration. 

3.2.38 . Maintenance level. The separation of maintenance 

activities or functions in the DoD according to the required 

skills and available facilities. 

3.2.39 . National Maintenance Work Requirement (NMWR). A 

maintenance serviceability standard for depot level reparables 

that do not have an existing depot maintenance work requirement 

and for field level reparables that are repaired by maintenance 

activities below the depot level maintainers for return to the 

DoD supply system. 

3.2.40 . Note. A statement or some other notification that adds, 

emphasizes, or clarifies essential information of special 

importance or interest. 

3.2.41 . Outer shell. The Outer Shell is the portion of the screen 

that surrounds the Inner Shell. This part of the screen should 

not be modified or controlled by the developer. 

3.2.42 . Page-based technical manual. A technical manual 

consisting of text, illustrations and tabular data presented in 

a standard page-oriented format. 

3.2.43 . Pictorial. A type of illustration showing the physical 

appearance of equipment or component parts. This term is used 

instead of such general terms as illustration, drawing, or 

diagram. 

3.2.44 . Pop-up menu. Pop-up menus are menus that the user 

specifically invokes by right mouse clicking. The pop-up menu 

appears at the cursor location. 

3.2.45 . Portable Network Graphics (PNG). PNG is an extensible 

file format for the portable, well-compressed storage of raster 

images. The PNG specification was issued as a W3C 

Recommendation in 1996. 

3.2.46 . Schematic diagram. A graphic representation showing the 

interrelationship of each component or group of components in 

the equipment. The essential characteristic of these diagrams 

is that every maintenance-significant functional component is 

9 Enclosure (4)


separately represented. Also, where appropriate, voltage 

readings should be shown. 

3.2.47 Session control. Session control is the ability to stop and 

start an IETM session in the middle of work. For highly 

interactive IETMs, this involves saving the state of the session 

for later reload to re-establish the user session back to where 

it was before the interruption. 

3.2.48 Standard Generalized Markup Language (SGML). A language for 

document representation that formalizes markup and frees it of 

system and processing dependencies. 

3.2.49 Standard Generalized Markup Language (SGML) declaration. 

Defines which characters are used in a document instance, in 

which syntax the DTD is written, which SGML features are used, 

etc. 

3.2.50 . Technical Manual Quality Assurance (TMQA) program. A 

systematic, coordinated effort to establish a high level of 

confidence that the TM product offered conforms to established, 

contractually defined technical requirements. A QA program 

includes efforts by the contracting activity and acquiring 

activity, including, but not limited to, IPRs, validation, and 

verification. 

3.2.51 . Technical Manuals (TMs). Manuals that contain 

instructions for the installation, operation, maintenance, and 

support of weapon systems, weapon system components, and support 

equipment. TM information may be presented, according to prior 

agreement between the contractor and the Government, in any form 

or characteristic, including hard printed copy, audio and visual 

displays, disks, other electronic devices, or other media. They 

normally include operational and maintenance instructions, parts 

list, and related technical information or procedures exclusive 

of administrative procedures. 

3.2.52 . Text. The written parts of the technical sections 

excluding labels, legends, and callouts in illustrations. 

3.2.53 . User. A person using the technical manual. 

3.2.54 . User navigation panel. This part of the Inner Shell 

provides a Main Menu Bar of the necessary common functions 

and/or options. 

3.2.55 . Validation. Process by which the contractor tests a TM 

for technical accuracy and adequacy, comprehensibility, and 

usability. 

3.2.56 . Verification. The final QA iteration by the Government 

for acceptance of the TM during which a TM is tested to 

Enclosure (4) 10


determine its adequacy and operational suitability for operation 

and maintenance of equipment or systems using target audience 

personnel. The government may perform their verification by 

observing the contractor's validation. 

3.2.57 . World Wide Web Consortium (W3C). The World Wide Web 

Consortium (W3C) develops interoperable technologies 

(specifications, guidelines, software, and tools) to lead the 

Web to its full potential. W3C is a forum for information, 

commerce, communication, and collective understanding. 

3.2.58 . XML Style sheet Language (XSL). XSL is a language for 

expressing stylesheets. It consists of three parts: XSL 

Transformations (XSLT): a language for transforming XML 

documents, the XML Path Language (XPath), an expression language 

used by XSLT to access or refer to parts of an XML document. 

(XPath is also used by the XML Linking specification) 

4. GENERAL GUIDANCE. 

4.1 . General. The objective of IETM acquisition is to procure 

standard SGML/XML/XSL tagged IETM data that is optimally 

structured with internal reference linking to create survivable 

data in revisable and economically maintained databases by 

sharing common objects. Although, interactive PDF with internal 

reference linking is allowed the goal is to acquire XML tagged 

documents. 

4.1.1 . Integrated Data Environment (IDE). The IDE is a dynamic 

data environment in which all users draw from a common virtual 

database containing data maintained by an unlimited number of 

Government or commercial service providers. This philosophy is 

a key element in the migration toward the IDE. A shared 

information environment providing immediate access to digital 

data supports the IDE. 

4.1.2 . IETM acquisition choices. An IETM may also be procured as 

a logistic support product under a major weapon system or 

equipment buy, as a separate item under its own contract to 

support new equipment, or as a conversion. 

4.1.3 . IETM acquisition considerations. There are a number of 

choices to be considered for the acquisition of IETMs, several 

of which may have a direct impact on the type of technical data 

presentation method that is contracted for. 

4.1.3.1 . Resources. Resources also are provided that may help the 

acquisition manger evaluate the cost benefit associated with 

IETM acquisition and trade off higher functionality requirements 

with maximum return on investments. 

11 Enclosure (4)


4.1.3.2 . Purpose and goal. This document provides a resource of 

tools, which helps the acquisition manager contract the 

functionality required in IETMs. The acquisition process should 

be in a manner that can subsequently be priced by bidders and 

compared and contrasted in a competitive bid. This document is 

intended to provide guidance of the relative complexities of 

these functionalities, which equates to costs, as well as a 

draft statement of objective language that can be tailored for 

the acquisition of an IETM. 

4.2 . Determining IETM functionality. Consideration should be 

given to the features and capabilities that are desired to 

support users from novices to advance. Refer to the IETM 

Functionality Matrix for additional information. 

5. VIEWER COMPONENTS. 

5.1 . Overview. The Web viewer is an integral component that 

resides on the client side. It should support the features 

needed by the server side that provides the functionality to the 

IETM. Because IETMs provide a range of capabilities to the 

user, the browser should be capable of supporting a range of 

features as well. 

5.2 . Available viewers. Currently, there are two major viewers 

featuring competing technologies that may support IETM 

capabilities. Microsoft's Internet Explorer and Netscape's 

Navigator both support basic Web surfing capabilities. However, 

when higher level scripting is introduced, there is the chance 

that incompatibilities may be encountered. It is important to 

design the IETM to detect the type of viewer in use by the 

client and provide the appropriate code to support that 

particular viewer across all platforms. 

5.3 . Outer shell. The outer shell (see figure 1) is the portion 

of the screen that surrounds the inner shell. IETM developers 

should not attempt to modify or control the outer shell. 

5.4 . Inner shell. The inner shell (see figure 1) is the portion 

of the IETM, within the browser shell, provided as the client 

application display area. The only portion of the screen real 

estate under the developer’s control is the inner shell. The 

outer shell is the portion of the screen that surrounds the 

inner shell. The developer should not attempt to modify or 

control the outer shell. As technology changes, the impact on 

the outer shell is unknown. For example, the Task Force Web 

Portal and the User Facing Service do not allow the developer 

the flexibility to control the outer shell. The inner shell 

contains specific regions, these regions are: 

Enclosure (4) 12


a. Guide post 

b. Table of contents panel 

c. Classification bar 

d. Navigation panel 

(1) Subtitle bar 

(2) Main menu bar 

(3) Project specific bar 

e. Main content area 

f. Status bar 

Title Bar - Classification 

File Edit View Favorites Tools Help 

Guide Post 

Title Bar 

Classification Bar 

Subtitle Bar 

Main Menu Bar 

Project Specific Bar 

Outer 

Shell 

INNER SHELL 

Table of 

Contents 

(TOC) 

Main Content Area 

Status Bar 

FIGURE 1. Example of inner and outer shell. 

5.5 . General screen. Within the inner shell is a guidepost in the 

upper left hand corner and to the right of the guidepost is an 

optional classification and a navigation panel. On the left 

side of the inner shell below the guidepost is a resizable area 

13 Enclosure (4)


to display list of contents, list of figures, list of tables, 

etc as selected in the guidepost. The navigation panel should 

be divided into the subtitle bar, the main menu bar and the 

project specific bar in that order. The general form should be 

the “inverted L” with the guidepost in the upper left hand 

corner. The optional status bar should be located at the bottom 

of the inner shell. The rest of the inner shell should contain 

the main display screen (refer to figure 2). 

5.6 . Guidepost functions. This area should allow the user to get 

to and initiate special advanced functions or to return the user 

to default settings as described herein. A logo for the 

guidepost may be used. 

a. Pop-up menu. Right mouse clicking on the guidepost area 

should provide the following guide post functions menu via 

a pop-up. 

b. Reset. If the user interface can be changed, a user should 

be able to reset the user interface back to the default, 

defined as the user interface defined upon normal start-up 

of the IETM for the first time. 

c. Minimize IETM. This should cause the IETM to disappear 

from the screen and indicate an active application on the 

application tool bar for the operating system. 

d. Exit IETM. This should ask the user if they wish to exit 

the IETM and then if appropriate to save the session 

e. Print screen. Print what is on the IETM screen. 

f. Print page. Print the present screen including scrolled 

off information. 

g. Page view. Change to a paged view, usually PDF. 

h. Open new IETM. Open another IETM in a separate window. 

i. Pause and save work/location. For those IETMs that can 

pause, save and resume sessions. 

j. Resume saved work/location. For those IETMs that can 

pause, save and resume sessions. 

k. Create TPDR. Create a TPDR for the portion of the IETM 

currently being used (for IETMs that use this function). 

l. View change summary. Should allow user to view the change 

summary. 

m. Resume. Should allow user to resume if user accidentally 

brought up the guidepost and does not need to do anything. 

Enclosure (4) 14


n. Get to administrative information. Allow user to view the 

front matter and other administrative information. 

o. Abort browse mode. If browse mode is implemented, allow 

the user to exit from the browse mode. 

Guide Post 

Classification Bar 

Subtitle Bar 

Main Menu Bar 

Project Specific Bar 

Table of 

Contents 

(TOC) 

Main Content Area 

Status Bar 

FIGURE 2. Example of inner shell. 

5.6.1 . Guide post. The guidepost provides a special mechanism for 

navigation and preferences. For example, the guidepost may 

provide a menu allowing the user to toggle screen areas, such as 

the table of contents (TOC), on and off. The guidepost may be 

toggled on and off but should always be accessible. The 

guidepost or compass rose icon should always remain visible. If 

you need the real-estate and you have an exceptionally rare and 

unusual case, then the guide post or compass rose icon 

representing the minimized guide post should provide the means 

to restore the inner shell to user default settings. 

5.6.2 . Toggled off functions. When toggled off, the guide post 

should provide the following: 

15 Enclosure (4)


a. Be easy to find by the user. This could be achieved 

through an icon such as a compass rose or by a right click 

menu. Selecting this area should provide a functions menu. 

b. The guidepost function menu should be accessible by a right 

click from anywhere within the inner shell. 

c. Be large enough to be visible and user selectable. For 

example, when the TOC panel is toggled off the width of the 

guidepost should still be visible and accessible. 

5.6.3 . Toggled on functions. When toggled on the guide post 

should provide the following: 

a. Displayed in the upper left corner of the inner shell. 

b. Resized with the TOC panel, navigation panel, and 

classification bar. 

c. Icon such as a compass rose may be used to depict the 

guidepost area. 

5.7 . Additional functions. The guidepost function shall provide 

a special mechanism for navigation and preferences. Selecting 

on this area shall provide a function menu. This should include 

a menu allowing the user to toggle screen areas on and off. 

This includes the guidepost, TOC, classification bar, project 

specific bar and the status bar. A menu item should be grayed 

out if it is not permitted to toggle that particular screen area 

off. The guidepost should not be part of the navigation panel. 

5.8 . Drill up/drill down. When a guidepost is provided, the 

drill up/drill down function in the guidepost walks through the 

fully expanded TOC, which need not be displayed at the moment in 

the left hand TOC area. Drill up moves you back up the fully 

expanded TOC and drill down moves you down through the fully 

expanded TOC. Fully expandable TOC means all levels of the TOC 

can be displayed. When a guidepost is provided a drill 

up/drilldown function should be available. 

5.9 . Table of Contents (TOC). The area on the left side below 

the guidepost is the area where the TOC should appear (refer to 

figure A-4). This area should have a resizable right-side 

border (so that the TOC area can be reduced in size to the 

left). The TOC panel may be toggled on and off. When the 

guidepost is not shown, the TOC should appear on the left side 

under the navigation panel. When the user hovers the cursor 

over a TOC item, the full name of the TOC item should appear. 

Access should be provided via a hierarchical breakdown such as, 

system/subsystem, content functional, physical hierarchy, or by 

means of graphical interfaces. The TOC list contains work 

Enclosure (4) 16


packages. Under a work package you may list paragraphs, tasks, 

figures, tables, etc. The TOC may also include links to other 

useful information such as “How-to-Use”, authentications, 

warning summary, etc. 

a. List of tables. Tables should be displayed in the display 

area for the TOC and the original TOC is hidden (or simply 

not displayed) while the list of tables is presented. 

b. List of Figures. Figures should be displayed in the 

display area for the TOC and the original TOC shall be 

hidden (or simply not displayed) while the list of figures 

is presented. 

5.10 . Classification bar. When shown, the bar should appear as 

the top most bar of the inner shell, and when the guidepost is 

shown to the right of the guidepost. The classification bar is 

mandatory if classification exists and should not be toggled on 

and off. If the IETM content is classified, security markings 

should be displayed in the classification bar as well as the 

title bar of the outer shell. 

5.11 . Navigation panel. The navigation panel should consist of 

three a horizontal bars in the following sequence; a subtitle 

bar, a main menu bar, and a project specific bar. The subtitle 

and the project specific bars are optional. The navigation 

panel should appear as follows: 

a. Above the main content area. 

b. To the right of the guidepost when the guide post is shown. 

c. Under the classification bar when the classification bar is 

shown. 

d. The position of the navigation panel should, as far as 

possible, remain consistent throughout the application. 

5.12 . Subtitle bar. When used the subtitle bar should appear as 

follows: 

a. If there is an outer shell, the subtitle bar is optional 

and may be toggled on and off. 

b. The subtitle bar may be used for additional identifying 

information. 

5.13 . Main menu bar. The main menu bar consists of nine 

mandatory functions. They shall be presented graphically (refer 

to 6.3.5). The main menu bar may contain additional project 

functions appearing to the right of the standard functions. 

Additional functions may optionally be added to the project 

specific bar. Cascading menus may appear as a child of a 

17 Enclosure (4)


function when selected. In a drop-down menu, this appears next 

to the function selected. There may be several levels of 

cascading menus. Functions that are not active during any 

rendering shall be presented as disabled (grayed out). The main 

menu bar is mandatory and shall not be toggled off. The bar 

shall remain accessible by persistent visible indication (e.g., 

the guide post). 

5.14 . Project specific bar. The project specific bar can be used 

if additional functions are required. Consideration should be 

given for placement of functions on the project specific bar 

with respect to main menu bar functions to minimize potential 

for making incorrect selections (for example, the project 

specific functions may be oriented so that the functions are 

right justified). The project specific bar is optional and may 

be toggled on and off. Functions that are not active during any 

rendering should be presented as disabled (grayed out). 

Cascading menus may appear as a child of a function when 

selected. In a drop-down menu, this appears next to the 

function selected. There may be several levels of cascading 

menus. 

5.15 . Main content area. The main content area contains the text 

and graphics of the IETM, specifically excluding the table of 

contents panel, guide post, classification bar, navigation panel 

and status bar. 

5.16 . Status bar. The status bar should be a horizontal bar 

located at the bottom of the inner shell. The status bar should 

contain status information including status indicators and icons 

for active (persistent) warnings, cautions, and notes. The 

status bar may be toggled on and off when there are no 

persistent alert icons. The status bar should not be toggled 

off when persistent alert icons are displayed. 

5.17 . Screen sizes. Proper planning for the size and resolutions 

of various devices up front in the planning stages makes lifecycle 

sense as the presentation technology is always undergoing 

change (e.g., terminals, desktops, laptops, personal digital 

assistance devices, etc). 

6. MAINTAINING A COMMON LOOK-AND-FEEL AMONG DIFFERING IETMs. 

6.1 . Overview. While the use of the common browser does 

standardize many of the user-interaction features, it is very 

likely that a custom component may contain its own set of unique 

user-interaction features layered under the higher-level browser 

toolbars. These features often conform to a proprietary lookand-feel 

dictated by the COTS product being employed. However, 

the need for a procurement-guidance document that can be 

Enclosure (4) 18


employed to minimizing the differences in look-and-feel among 

various disparate IETM presentation components that operate in 

the JIA environment still exists. From both the Training and the 

Job Performance perspective, the effectiveness of each product 

is enhanced when it is displayed in accordance with a standard 

style, even if the actual underlying IETM presentation 

components vary and are proprietary in nature. 

6.2 . Joint NAVAIR/Industry user-interaction requirements. A 

preliminary set of standard “look-and-feel” recommendations is 

included in this document. It may be used to prepare guidance 

for the suppliers of IETMs and IETM software products. These 

requirements permit the use of contractor selected authoring and 

presentation products while, at the same time, preserving the 

essence of a common NAVAIR look-and-feel if the software 

products adhere to the requirements. 

6.2.1 . Joint-Service IETM technology. These requirements are the 

result of a workshop between members of the individual Services 

(selected by the Joint-Service IETM Technology Working Group 

members) and the Aerospace Industries Association (AIA) Service 

Publications Panel. The guidance contained herein greatly 

reduces the existing performance requirements to those few that 

are really needed, and tightens down those few remaining 

recommendations to be as specific as possible. The intent is 

that these requirements eventually replace the user-interaction 

requirements sections of MIL-PRF-87268, Manuals, Interactive 

Electronic Technical: General Content, Style, Format, and User- 

Interaction. 

6.2.2 . Contract guidelines. IETM TMCRs (Technical Manual Contract 

Requirements) and other procurement instruments may reference 

that delivered IETM view packages conform to both the JIA 

performance recommendations and the included look-and-feel userinterface 

recommendations. By doing so, it should be possible to 

obtain a meaningful level of common NAVAIR IETM look-and-feel 

interface without needing the acquisition of a custom IETM 

system. 

6.3 . Preliminary user-interaction requirements for NAVAIR IETMs. 

The following is a preliminary set of IETM User-Interaction 

(“look-and-feel”) requirements and should be observed in 

preparing IETMs and the associated viewing software components 

for NAVAIR: 

6.3.1 . Display format (text/font, graphic, table, lists, object 

embedding). 

a. Use best commercial practices. 

19 Enclosure (4)


b. Use of multiple frames is not a requirement. 

c. Single window with no more than 4 panes; pop up windows 

allowed for pan and zoom of graphics, external references, 

etc. (assume that std. Display device is based on 800 x 600 

laptop design). 

6.3.2 . Browse capability. Browse capability should be available. 

a. User controlled access mode. 

b. No tracking of activities. 

c. Not rigidly tied to IETM controls. 

6.3.3 . Link behavior/navigation. 

a. All Hot Spots should be visually indicated (e.g., fill 

pattern, reverse video, outline, button, and underline). 

b. If you are executing a link that is not a goto or exit 

link, you should be able to return to the link source from 

the link destination. 

c. There are three acceptable mode of visual indication of 

hot-spots (selectable areas). 

(1) Persistent visual indication that an area is hot. 

(2) Cursor changing shape/color. 

(3) Object changes while cursor over area (e.g. IPB callout 

expands). 

6.3.4 . Control bars. 

a. The User Navigation Panel (Tool Bar) should provide the 

necessary choices/options available at the current time. 

b. The User Navigation Panel is needed with an optional toggle 

capability to turn it off. 

c. The User Navigation Panel should remain accessible by 

persistent visible indication. 

d. Use the standard icons when applicable in the User 

Navigation Panel. 

6.3.5 . Icon standardization. 

a. An icon should show its name or function when the cursor is 

stalled over the icon. 

b. Suggested Icons for standardization: 

Enclosure (4) 20


(1) Next - shown by a right pointing arrow that moves you 

down through the fully expanded TOC. 

(2) Previous [Chronological] - previous moves you back up 

the fully expanded TOC. 

(3) Return [Chronological] - shown by an arrow pointing 

down and right, to return the user to . . . 

(4) Back [Logical] - shown by a arrow pointing up and left 

that navigates you back to your previous location in the 

IETM. 

(5) TOC (possibly various types: List of Figures, Tables, 

etc.) - general navigation, may be shown with a stack 

of documents. 

(6) Exit (icon should provide a menu of exit options) - 

exits the user from one of the three supported modes: 

(a) Complete (save and update history). 

(b) Abort (do not save or update history). 

(c) Suspend a session at any time (e.g., for a break or 

emergency). 

(7) Find/Search (refer to 7.3.7) - perform a keyword 

search against valid entry points (e.g. TOC or list of 

content). 

(8) User Navigation Panel Toggle. An optional toggle 

capability to turn off the user navigation panel. The 

guide post (or compass rose for a minimized guide post) 

and classification bar should remain visible. 

(9) Parts (IPB/RPSTL) 

(a) Parts Info - provide parts information on 

selected parts within the IETM. 

(b) Parts Ordering (shopping cart icon) - provide a 

link to an external location (e.g. parts database, 

forms etc.) to order parts. May also provide access 

to a parts ordering system. 

21 Enclosure (4)


(10) Suggested Changes/Feedback - allows the user to send 

feedback via an electronic form. 

(11) Training - provide IETM specific training and or 

help. May provide technical school training on specific 

tasks or equipment. 

(12) Multimedia Icon (not req’t) - provide access to 

available multimedia. 

(13) Sound/Voice Icon (standard speaker con) - controls 

muting and volume via system controls (versus embedded 

controls within the application). As an option the IETM 

can provide convenient access to the system controls. 

(14) Full Motion Video Icon (standard movie camera icon) 

- shows available videos. 

(15) Animation Icon - displays animations for performing 

flow-tracing during troubleshooting. 

(16) Graphic 

(17) Diagnostics (not req’t - pull down menu option) 

(18) Wiring Diagrams (not req’t - pull down menu option) 

(19) Acronyms (not req’t - pull down menu option) 

(20) Abbreviations (not req’t - pull down menu option) 

(21) Help (? icon and also menu bar option) - IETM 

specific help. 

(22) Version Info. (not req’t - pull down menu option) 

(23) Warning - the warning marking is used to indicate a 

location, equipment, system where a potential hazard 

exists capable of producing injury to personnel if 

approved procedures are not followed. Selecting this 

icon displays the warning. 

(24) Caution - the caution marking is used to indicate 

where a hazard exists that could severely damage 

equipment, system causing loss of mission capability if 

Enclosure (4) 22


approved procedures are not followed. Selecting this 

icon displays the caution. 

(25) Note - the note marking is used to indicate a 

special piece of information. Selecting this icon 

displays the note. 

(26) Hazards Icons such as those included in MIL-STD-38784 

(app A) - (use current standards) 

(27) Print (printer icon) - selecting this icon may 

produce a dialog box with the following choices: 

(a) Print IETM graphic 

(b) Print active IETM window 

(c) Print IETM page 

(d) Print IETM on demand 

(28) One-way link (Goto) - the user cannot return via the 

IETM to this point (possibly through history, but return 

here is not guaranteed). 

(29) Two-way link (Gosub) - the user can return here from 

the remote location. 

(30) Relational link (not req’t) - related materials 

(possibly more than one) are available. Works exactly 

like a gosub. 

(31) Browse (icon should indicate active browse mode) - 

allow the user to exit from the browse mode. 

6.3.6 . Warnings, cautions and notes. 

a. User should acknowledge pop up warnings and cautions before 

proceeding. 

b. Pop up alerts should be centered on the screen. 

c. A persistent icon should appear on the screen when alert is 

applicable. 

d. Standard colors for alerts: Red – Warning, Yellow – 

Caution, Cyan – Note. 

6.3.7 . Search and lookup. 

a. User can invoke search function via an icon or menu option. 

23 Enclosure (4)


b. Users should be presented with the available search 

options. 

6.3.8 . Session control (suspends, resume and nested sessions). 

a. The user should be able to suspend a session at any time 

(e.g., for a break or emergency). 

b. A resume function should be capable of re-starting the 

session at the same point it was suspended. 

c. At the time of resume, the user should be advised that some 

key parameters/condition settings may be outdated (e.g., 

aircraft safe for maintenance, temperature change, or other 

people worked on the end-item/platform during the 

suspension). 

d. The system should support the four Transition Modes: 

(1) Complete (Save and update history) 

(2) Abort (Do not save or update history) 

(3) Suspend (See 7.3.8.a.) 

(4) Resume 

6.3.9 . Context filtering. When context-filtering capability 

exists in the IETM, the application should determine how the 

functionality is executed. When content filtering is used in an 

ITEM, the application may determine how the functionality is 

executed. 

a. The system should have the ability to perform context 

filtering on effectivity as a minimum. 

b. The system should provide the user a mechanism for 

entering/modifying configuration parameters. 

6.3.10 . Screen resolution and color guidelines. 

a. Presentation system and graphics developers should consider 

the use of standard “safe” colors visible across multiple 

presentation systems. 

b. Presentation systems should not presume any fixed display 

resolution, or size. 

6.3.11 . Information access (indices, electronic TOCs, etc.). 

a. A Table/List of all key entry points should be made 

available for user access. 

b. Access should be provided via a hierarchical breakdown such 

as: 

Enclosure (4) 24


(1) SSSN (MIL-STD-1808) 

(2) LCN 

(3) ASD 1000D 

(4) Functional and physical hierarchy 

c. Graphical Interfaces are acceptable. 

6.3.12 . Dialogs. 

a. Support should be provided for both pop-up dialog box and 

in-line dialogs in the display frame itself. 

b. Developers should use best commercial practices for 

entering data in dialog boxes (e.g., radio buttons, checkboxes, 

fill-ins, combo boxes, scrolling selection lists, 

etc.). 

6.3.13 . Sound (optional). 

a. Developers should use best commercial practices when 

implementing sound. 

b. The user should take action to hear the sound. (No 

automatic playing of sound.) 

c. User controls muting and volume via system controls (versus 

embedded controls within the application). Optional: 

Application can provide convenient access to the system 

controls. 

6.3.14 . Voice input/output (I/O) (optional). 

a. Voice I/O should be used only as supplemental input/output 

and navigation. 

b. Keyboard and pointing devices should be the primary input, 

and visual display should be the primary output. 

6.3.15 . Graphics. Developers should use best commercial practices 

for graphics format and display. 

6.3.16 . Hardware user interface. 

a. Point and click capability on target display should be 

assumed (e.g., point and click, selection keys, A/N 

keyboard, touch pad, etc.) 

b. Developers should accommodate the limitations of the target 

display device. 

c. Alphanumeric input capability should be provided, if not in 

hardware, then in software. 

25 Enclosure (4)


6.3.17 . Performance (response time by context). 

a. Developers should implement a less than 2-second response 

time goal. 

b. If the response time is greater than 2 seconds, the system 

should provide visual feedback to the user (e.g., use a 

standard cursor for processing indication). 

6.3.18 . Printer output. 

a. Printed output is strongly discouraged. 

b. All printer output should have version number and/or 

printed date/time stamp. 

c. When customer needs printed output: 

(1) Printer output should not have to conform to normal 

paper TM specifications. 

(2) Satisfactory Options: 

(a) “Pre-composed” files (such as Adobe PDF) can be 

attached. 

(b) “On-the-fly” composition for printing (of logical 

element) built into the viewing application. 

6.3.19 . User annotations. 

a. There should be a persistent visual indication that an 

annotation exists (e.g., comments, notes, redlines, 

bookmarks). 

b. The default initial presentation of annotations is to 

appear minimized. 

c. If there are levels of annotations (e.g., public, private, 

etc.), they should be visually differentiated. 

6.3.20 . Feedback to originator. 

a. A single user interaction should be available to select the 

function. (e.g., a button, double mouse click). 

b. The preferred user interface is a form. 

c. The system should provide output options compatible with 

the user environment. 

d. There should be a “Form fill-in completed” function before 

returning to the IETM (e.g., “submit,” “done,” “okay,” 

“close-out”.) 

Enclosure (4) 26


e. The system should automatically generate an electronic 

locator (e.g., address, version) and to the greatest extent 

possible, relevant fields on the form should be 

automatically filled-in (e.g., user ID, system state, 

etc.). 

6.3.21 . Administrative information. Administrative information 

should be displayable (e.g., effectivity, authorization, 

distribution, and validation/verification). 

6.3.22 . Interface to external references and systems. A single 

user interaction should electronically link to external 

references (e.g., another IETM) or external systems 

(Support/Parts Ordering, etc.). 

6.3.23 . Rapid action changes and critical safety interim messages. 

a. A visual indication of the existence of a critical change 

should be displayed in context. 

b. A single user interaction should be available to access the 

change. 

c. The user should be provided with a visual indication for 

critical messages at the start of the IETM. 

7. IETM FORMATTING GUIDELINES. 

7.1 . Use of a style sheet. The style sheet specifies the desired 

screen presentation of the information content of the document 

instances. IETM formatting requirements such as layout and 

hyphenation rules should be specified in the style sheet, as 

well as how IETM elements such as paragraph titles, tables, and 

lists are to be displayed. The style sheet should provide the 

composition and imaging characteristics to be applied to the XML 

tagging (including attributes) of an XML-tagged text source file 

(document instance) to present the text material in screen 

presentation form. 

7.2 . Display of text. Textual information should be displayed in 

data panes of the client area. Text should be displayed in 

uppercase and lowercase characters. 

27 Enclosure (4)


TABLE 3. Minimum and optimal character heights for various 

viewing distances at viewing angles of 16 and 20 minutes of arc. 

Viewing Distance 

(Inches) 

Minimum Character 

Height 

16 Minutes of Arc 

(Inches) 

Optimal Character 

Height 

20 Minutes of Arc 

(Inches) 

18 0.08 0.11 

24 0.11 0.14 

30 0.14 0.17 

36 0.17 0.21 

42 0.20 0.24 

48 0.22 0.28 

54 0.25 0.31 

60 0.28 0.35 

66 0.31 0.38 

72 0.34 0.42 

NOTE: The formula used for the above calculations is: 

Character Height = [(Min of Arc x Viewing Distance)/(57.3 x 

60)]. 

7.2.1 . Character font. All titles, headings, callouts and special 

characters should be sans-serif font. Narrative text should be 

sans-serif font. Table 3 lists the minimum recommended 

character heights for various reference viewing distances and 

should be used to determine the appropriate character font size. 

Unless otherwise specified by the procuring activity, the 

minimum reference viewing distance should be 36 inches. 

7.2.2 . Character spacing. Character spacing in textual displays 

should be no less than 0.1 character height. Between word 

spacing for textual displays should be one character width (em 

space). 

7.2.3 . Line dimensions. Between line spacing for textual display 

distances 0.33 of character height exclusive of superscripts and 

subscripts and no less than 0.15 character height when 

superscripts and subscripts are displayed. 

7.2.4 . Text panes. The width of the text pane should range from 

30-60 characters per line. 

Enclosure (4) 28


7.3 . Margins. Margins should be required for all text panes to 

prevent information from being obscured by borders or 

information in adjacent panes. 

7.4 . Justification. Left justification should be used for all 

lines of text displayed as sentences or paragraphs. 

7.5 . Word wrapping. Lines of text should wrap, so that no line 

extends beyond the limits of the pane or right margin, including 

when resized. Lines should be broken only between individual 

words or within a word when that word is explicitly hyphenated. 

If resized text exceeds the text pane area, vertical scrolling 

should be used. 

7.6 . Hyphenation. Hyphenation should not be used to display 

normally non-hyphenated words on successive lines. 

7.7 . Tables. Tabular information should be displayed as cells of 

textual information or a graphic. When tables contain textual 

elements, those elements should conform to the requirements 

herein, for textual information. Graphical elements within a 

table should conform to the requirements herein, for graphic 

material. 

7.7.1 . Display of tables. Tables should be displayed in a leftto-right, 

top-to-bottom array of cells. Tables should have 

column headers and, if applicable, row headers. 

7.7.2 . Justification. Lists of alphabetic data should be 

vertically aligned with left justification. Numerical data 

should be justified with respect to a fixed decimal point. In 

cases where there is no decimal point, the numerical data should 

be right justified. 

7.7.3 . Column spacing. Consistent column spacing should be 

maintained within a table. When more than one column of data is 

displayed, sufficient space should be provided to clearly 

distinguish the data. 

7.7.4 . Row spacing. For dense tables with more than ten rows, a 

grouping feature (i.e., a solid or blank line) may be inserted 

after every fifth row. 

7.8 . Graphics. The IETM should display graphics in a data pane 

as follows. 

7.8.1 . Display of graphic overlays. Encoded graphics should be 

displayed along with any associated callout overlays designed to 

indicate the specific components of the graphic. 

7.8.2 . Types of graphics. Two types of graphics should be 

displayed: static and interactive. Static graphics should be 

29 Enclosure (4)


displayed in full detail in the graphic area provided, with no 

ability for manipulation. Interactive graphics should provide 

the capability for manipulation. 

7.8.3 . Scale. Graphics should be displayed to a scale at least as 

large as its designated minimum size so that all essential 

detail is legible. 

7.8.4 . Display. Graphics should be displayed in a pane of the 

displayed window. If a graphic cannot be displayed in its 

entirety and in full detail, it should be displayed using 

interactive graphic display techniques described in this 

specification (e.g., scrolling, zooming). 

8. IETM AUTHORING GUIDELINES. 

8.1 . Authoring style guidelines for IETMs. To ensure clarity 

within IETM data, the following principles should be followed in 

authoring technical information. 

a. Essential information in narrative text should: 

(1) Describe the system, components, etc., identifying 

special or outstanding features. 

(2) Describe what functions are performed, including 

inputs, outputs, interface with other systems, etc.; 

emphasize end results. 

(3) Describe how the functions are performed, including 

associated principles of operation. 

(4) Describe at what point in an overall system process 

the function is performed. 

(5) Describe the location of the component or part. 

b. When procedural text is combined with graphics, the 

following rules should be used to abbreviate, so long as 

the meaning is not altered or obscured. 

(1) Eliminate articles. 

(2) Begin sentences with transitive verbs (action verbs). 

(3) Use the imperative mood whenever appropriate. The 

only time subjects should be implied is when they are 

unknown and the passive voice is being used or when the 

imperative mood is being used to give an instruction, 

order, or command, in which case the subject should 

always be omitted (i.e., implied). 

c. When it is necessary to indicate time, begin sentences with 

“when” clauses. Example: “When power supply voltage 

stabilizes...” 

Enclosure (4) 30


d. Limit paragraphs to a single idea. Limit sentences to a 

single thought; use no compound or complex sentences. 

Whenever possible, limit words to those that are short and 

familiar to the target audience. Eliminate long, complex 

sentences and paragraphs through the use of lists. The 

resulting parallel portions of sentences should be 

individually listed as in the following example: 

The beat frequency oscillator has three components: 

(1) ... 

(2) ... 

(3) ... 

e. Sentence length should not exceed an average of 20 words. 

The average paragraph should not exceed six sentences. The 

desired paragraph length is three to four sentences. Each 

paragraph should have a topic entry or sentence. All 

material in the paragraph should relate to and develop the 

topic sentence. 

f. Except in unusual circumstances, text modules (e.g., 

construct steps and explanations) should be fully 

integrated with graphics modules. Associate explanatory 

text to the graphic. 

g. Present descriptive text in a logical order (e.g., in 

operational sequence or in signal flow sequence) and 

include summary headers for individual paragraphs whenever 

needed for clarity. 

h. Keep descriptive text consistent in terminology, style, and 

format throughout the IETM 

9. NOTES. 

9.1 . Intended use. This document is intended to be used as 

guidance for common look and feel of electronic technical 

manuals, which includes both ETMs and IETMs. 

31 Enclosure (4)


APPENDIX A 

IETM GENERAL CONTENT GUIDANCE 

A.1 SCOPE. 

A.1.1 Scope. This document includes guidance for preparing IETMs. 

A.1.2 Philosophy. This guidance contains general information and 

examples. This appendix must be used in conjunction with it. 

IETMs are designed for viewing through the use of an interactive 

computer-controlled Electronic Display System (EDS) or viewer. 

A.2 APPLICABLE DOCUMENTS. 

This section is not applicable to this appendix. 

A.3 DEFINITIONS. 

A.3.1 Acronyms used in Appendix A. The acronyms used in this 

appendix are defined as follows: 

ASF 

BMP 

CALS 

CBT 

CD-ROM 

CGM 

COE 

COTS 

DII 

DoD 

DoDISS 

DTD 

DVD 

GIF 

HTML 

IEC 

IETM 

I/O 

IT-21 

JEDMICS 

Advanced Streaming Format 

Bit Map 

Continuous Acquisition and Life-Cycle Support 

Computer Based Training 

Compact Disk Read Only Memory 

Computer Graphic Metafile 

Common Operating Environment 

Commercial Off the Shelf Software 

Defense Information Infrastructure 

Department of Defense 

DoD Index of Specifications and Standards 

Document Type Definition 

Digital Video Disc 

Graphic Interchange Format 

Hypertext Markup Language 

International Electrotechnical Commission 

Interactive Electronic Technical Manual 

Input/Output 

Information Technology for the 21st Century 

Joint Engineering Data Management Information and 

Control System 

Enclosure (4) 32


JPEG 

LOC 

LOI 

LOT 

MPEG 

MSD 

MWO 

NIFF 

NMCI 

ODA 

ODIF 

PC 

PDA 

PDF 

POD 

QA 

SATCOM 

SGML 

SSL 

SVG 

TFW 

TIFF 

TM 

TOC 

UFS 

VIN 

W3C 

WMA 

WMV 

XML 

Joint Photographic Experts Group 

List of Changes 

List of Illustrations 

List of Tables 

Moving Picture Experts Group 

Maintenance Support Device 

Modification Work Order 

Notation Interchange File Format 

Navy Marine Corps Intranet 

Open Document Architecture 

Open Document Interchange Format 

Personal Computer 

Personal Digital Assistant 

Portable Document Format 

Print On Demand 

Quality Assurance 

Satellite Communications 

Standard Generalized Markup Language 

Secure Sockets Layer 

Scalable Vector Graphics 

Task Force Web 

Tiled Image File Format 

Technical Manual 

Table of Contents 

User Facing Service 

Vehicle Identification Number 

World Wide Web Consortium 

Windows Media Audio 

Windows Media file with Audio/Video 

Extensible Markup Language 

A.3.2 Annotations. Annotations are the ability of the system 

administrator or user to place special notes within a manual. 

These notes can be public information for all users such as 

special information that requires rapid deployment to the manual 

holders like “Advance Change Notices.” They also can be private 

33 Enclosure (4)


notes needed only by the user to assist in their training or in 

the performance of their duties. 

A.3.3 Audit trails. Audit trails are the ability of the IETM to 

know where the user has navigated within the IETM. 

A.3.4 Autonomic logistics. A system that acts without human 

intervention and consists of two primary components: a 

Prognostics and Health Management System and a Joint Distributed 

Information System. The Prognostics and Health Management 

System collects information while the weapon system is in 

operation using sensors and diagnostics to detect faults and 

impending faults. Reasoning algorithms are used to determine 

the causes of the faults. The system detects degrading 

performance and thus can forecast the requirement to replace a 

component prior to its predicted failure. The Joint Distributed 

Information System communicates this information immediately 

through the logistics infrastructure, automatically acquiring 

the spare parts, tools, and manpower. 

A.3.5 Bookmark. Bookmarks are the capability to mark areas of 

interest to allow quick access. In today’s environment, the 

terminology bookmark has been expanded to include “favorites” 

and “shortcuts.” 

A.3.6 Cascading menus. A cascading menu is the child of the first 

menu item selected. In a both the drop-down menu format and the 

pop-up menu format, the child menu appears next to the first 

menu item selected. There may be several levels of cascading 

menus. 

A.3.7 Context filtering. Context filtering is when the 

presentation system automatically displays the relevant 

information applicable to the existing situation. For an 

example, only a specific piping system would be displayed in a 

compartment diagram or the level of instructions would be 

filtered based on the users level of ability (novice vice 

expert). 

A.3.8 Delivery. The method of moving technical data from a 

contracted vendor to the Government. 

A.3.9 Dialogs. Dialogs are the pop-ups and in-line collection 

mechanisms for gathering information for the IETM from the user. 

A.3.10 Diagnostics. Maintenance procedures that result in the 

identification of a repair; troubleshooting. May or may not be 

assisted with hardware/software tools. 

Enclosure (4) 34


A.3.11 Dialog box. A method for IETM to request and receive input 

from the user. A separate window displays a request and 

includes an area to input a response. 

A.3.12 Distribution. The method of moving technical data from an 

initial point to all the end users of the technical data. 

A.3.13 Drilling down. The process of navigating from broader 

focused content to more specific and detailed content. 

A.3.14 Effectivity. The act or process of identifying weapon 

systems or end-items and their hardware and software system and 

subsystems by their associated usable on code (UOC), serial 

number, model number, part number/CAGEC, NSN, end item code 

(EIC), software version or modification work order (MWO). 

Effectivity is included to signify that certain configuration 

(s) or modifications apply to a given weapon system/equipment. 

A.3.15 Element. A single discrete item in an IETM environment. 

A.3.16 Embedded. Describes hardware and or software which forms a 

integral part/component of some larger system and which is 

expected to function without human intervention. An embedded 

system usually does not include peripherals (e.g. keyboard, 

monitor, storage etc.). Embedded systems most often will 

provide real-time response. 

A.3.17 E-tool. An electronic device used for displaying technical 

data. 

A.3.18 Filtering. A process that narrows the displayed data to 

show only a specific and desired sub-set of data. As an 

example, the complete technical data for an aircraft can be 

filtered to only display to the user the data that applies to a 

requested tail-number. 

A.3.19 Fly through. A virtual three-dimensional navigation of a 

solid object. The user has the ability to control the 

perspective, direction and location of the displayed view of an 

object. The user also has the ability to virtually move through 

the object by dynamically changing the perspective, direction 

and location of the display. 

A.3.20 Frame-based IETM. An IETM that presents textual or 

graphical data in frames. The inner shell within the browser 

shell can contain multiple frames. Each frame can contain 

separate scrollable data. 

A.3.21 Guide post. The guidepost is the part of the user 

navigation panel that allows the user to get to and initiate 

35 Enclosure (4)


special advanced functions or to return to the standard default 

ribbon bar. 

A.3.22 Hot reference. A link to another location. A hot 

reference can be textual or graphical. 

A.3.23 Hot spot. An area of a graphic or a section of text, that 

activates a function when selected. Hot spots are used to 

invoke objects (i.e. multimedia, programs, applications, scripts 

etc.), where selecting a hot spot can display a graphic, run a 

video, or open a new pane of information. 

A.3.24 Human factor issues. An area of study concerned with the 

interaction between humans and computers. Includes efforts to 

most effectively design software interfaces to be most easily 

understood and efficiently used. 

A.3.25 Inference engine. A computer program that, based on user 

or other input, determines the correct sequence to display 

technical data in an IETM (also called a logic engine). 

A.3.26 In-line. Components such as frames, dialog boxes, figures, 

graphics, icons which are arranged sequentially to form a unit 

from overall parts. 

A.3.27 Inner shell. The inner shell is the portion of the IETM, 

within the viewer shell, provided as the client application 

display area. This is the only portion of the screen real 

estate, which is under the TM author’s control. 

A.3.28 Legacy TM. A technical manual developed to meet standards 

that have now been superceded by newer standards. 

A.3.29 Linking. The connection of two locations in a document to 

form a cross-reference. 

A.3.30 Logic engine. A computer program that, based on user or 

other input, determines the correct sequence to display 

technical data in an IETM (also called an inference engine). 

A.3.31 Maintenance session. All maintenance tasks completed 

during a single user’s shift while keeping an IETM open and 

active. 

A.3.32 Navigation. Traversing through technical data. Navigation 

may be accomplished via software inherent items (next and 

previous buttons) or through technical data inherent items 

(links). 

A.3.33 Near real time. Access to updated data at or near the time 

of content approval and posting. Network connectivity is 

required to achieve near real time access to data. 

Enclosure (4) 36


A.3.34 Online environment. The virtual environment contained 

within a computer and it’s connected (networked) devices. 

A.3.35 Outer shell. The portion of the screen that surrounds the 

Inner Shell. This part of the screen should not be modified or 

controlled by the TM author. 

A.3.36 Pane. An independent, rectangular, bordered region within 

the main content area of the inner shell. For example, in a main 

content area with 2 panes, one pane could contain a figure and 

the second pane the narrative information for that figure. The 

later pane could be designed to scroll the narrative information 

independent of the figure. 

A.3.37 PDA. Personal Digital Assistant. It is a hand-held 

electronic device capable of displaying IETMs. 

A.3.38 Persistent annotations. Annotations that are captured and 

retained for later use. 

A.3.39 Point and click. The functionality of selecting a process 

(like a link) by use of a mouse or other input device. 

A.3.40 Pop-up menus. Pop-up menus are menus that the user 

specifically invokes by right mouse clicking. The pop-up menu 

appears at the cursor location. 

A.3.41 Prognostics. Procedures that focus on preventative 

maintenance and care of equipment. May include health 

monitoring and linkage to autonomic logistics systems. 

A.3.42 SATCOM. Satellite Communications. 

A.3.43 Scrollable Frame IETMs. Any frame-based IETM that employs 

a visual cue (vertical or horizontal scroll bar) used to 

manipulate displayed text or graphics that exceeds the length or 

width of the data pane. The scrolling function permits the user 

to move through the textual or graphical data in a linear 

sequence that replicates the order of data normally found in a 

page-based document. The user may also have the capability to 

move through textual information, one line at a time, through 

the use of the SCROLL UP and SCROLL DOWN functions. A horizontal 

scroll bar is used only to display graphics and tables which 

exceed the width of the data pane. 

A.3.44 Scrollable IETMs. Any linear IETM that employs a visual 

cue (vertical or horizontal scroll bar) used to manipulate 

displayed text or graphics that exceeds the length or width of 

the data pane. The scrolling function permits the user to move 

through the textual or graphical data in a linear sequence that 

replicates the order of data normally found in a page-based 

37 Enclosure (4)


document. The user may also have the capability to move through 

textual information, one line at a time, through the use of the 

SCROLL UP and SCROLL DOWN functions. A horizontal scroll bar is 

used only to display graphics and tables which exceed the width 

of the data pane. 

A.3.45 Screen stacking. Screen stacking is when there are several 

windows open at the same time that are stacked one on top of 

each other in a staggered fashion. Screen stacking can confuse 

the novice user and is to be avoided. 

A.3.46 Search. A navigational method to locate and display 

desired information via the use of processes that match results 

to user requests. 

A.3.47 Session control. Session control is the ability to stop 

and start an IETM session in the middle of work. For highly 

interactive IETMs, this involves saving the state of the session 

for later reload to re-establish the user session back to where 

it was before the interruption. 

A.3.48 Sustainment. The processes and actions required to 

maintain technical data over its lifecycle. 

A.3.49 Tool tip. A small pop up that appears and contains helpful 

information. Moving the mouse over a preprogrammed element 

generally activates a tool tip. 

A.3.50 Touch screen. A device that allows the user to provide 

input to the IETM by touching the display screen. 

A.3.51 Tracking. The process of monitoring and retaining 

information about the navigational activities of a particular 

user or device. 

A.3.52 Traverse. The process of navigating through an electronic 

document. 

A.3.53 User navigation panel. This part of the inner shell 

provides a main menu bar of the necessary common functions 

and/or options. 

User session. The cumulative IETM -related activities of a 

single user from the point when the IETM use begins to the point 

when it ends uninterrupted by log-offs. A user session can be 

maintained by suspend/restart functionality. 

A.4 GENERAL CONTENT GUIDELINES. 

A.4.1 General. This appendix provides general content and 

guidance common to IETMs. This guidance applies specifically to 

standard revisable data base items that are used to create an 

Enclosure (4) 38


IETM. Content statements applying to the IETM are classified 

into two types: 

a. Those applicable to the construction of IETMs such as those 

dealing with the IETM technical structure and those 

required to support use of a particular IETM. Those 

applicable to specific technical processes to assure 

effective use of the IETM for the logistic support 

intended. 

b. Common content guidance for IETM structure used for such 

features as front (introductory) matter, list of contents, 

glossary, list of acronyms, statement of applicability, 

IETM number, IETM date, and IETM edition. 

A.4.2 Abbreviations and acronyms. Acronyms, abbreviations, and 

unusual terms may be used in any IETM text, when applicable. It 

is not necessary to spell out the words completely after the 

first use of an acronym or abbreviation. 

a. Abbreviations and acronyms, which are accepted as words 

(radar, sonar, laser, etc.) need not be included. 

b. Abbreviations and acronyms used should be in accordance 

with ASME Y14.38, except that abbreviations may be plural 

(s) or possessive ('s). New abbreviations and acronyms 

should not duplicate those presently listed in ASME Y14.38 

where possible. 

c. When abbreviations or acronyms are used as markings on the 

equipment (placarding), the same abbreviations or acronyms 

should be used in the IETM. 

A.4.3 Security classification and protective markings. Whenever 

classified and/or distribution restricted information is 

displayed an indication of the classification/distribution level 

shall be made within the viewer. When specified by the 

acquiring activity, a classified IETM should be prepared. The 

security classification markings for classified IETMs, should be 

identified in accordance with DoD 5200.1-R and DoD 5220.22-M, 

Executive Order 12958. For guidance on classification and 

handling restrictive markings on Compact Disk-Read Only Memory 

(CD-ROM), refer to MIL-HDBK-9660. 

A.4.4 Style and format requirements for technical content. The 

technical content format requirements for IETMs should be in 

accordance with the general requirements as specified by the 

acquiring activity. 

39 Enclosure (4)


A.4.5 IETM divisions. The hierarchy of an IETM consists of 

introductory matter, planning data and a series of work packages 

that include the types of data listed below. 

a. Descriptive information and principles of operation. 

b. Troubleshooting information. 

c. Procedural information (operator and maintenance tasks). 

d. Supporting information. 

A.4.6 Parts information. There should be links to the parts 

information database where the parts are called out in the text 

and on the graphics where the parts are identified. Parts 

information should be used to: 

a. Identify a part or parts by part number and name. 

b. Provide any additional parts data required to order the 

part. 

c. Show the relationship of a part to other parts of the 

system or equipment. 

d. Enhance or clarify the supporting operator, descriptive, or 

theory of operation data. 

A.4.7 Referencing. 

A.4.7.1 Other documents. When authorized by the acquiring 

activity, reference should be made only to other documents 

available and authorized to the user. Reference should be made 

by publication number. References to pending publication actions 

should not be made. 

A.4.7.2 Government specifications and standards. When authorized 

by the acquiring activity, reference should be made to the basic 

publication number for Government specifications and standards. 

A.4.7.3 Within the IETM. When it becomes necessary to reference to 

other work packages, descriptive information, maintenance tasks, 

or other data within the same IETM, it should be linked and 

referenced by title or appropriate text. The title should be 

the same used in the list of contents. 

A.4.7.4 Equipment, components, and parts. Reference to parts of 

the equipment and to equipment components may be by 

nomenclature, model, type and or reference designator. The 

referenced items may be linked to a graphic for identification 

and location. 

A.4.7.5 National Stock Numbers (NSNs) and Part Numbers (P/Ns). 

NSNs and part numbers should not be included in any text, 

tables, or illustration contained in a work package. NSN and 

Enclosure (4) 40


part number information for all equipment, components and parts 

should be accessible at any point in the presentation of WP 

text, tables and illustrations, when necessary, for the purpose 

of identification and parts ordering. 

A.4.7.6 Equipment panel markings (placarding). Reference should be 

made to panel markings and switch positions exactly as marked on 

the equipment. However, symbols on panel markings should be 

spelled out when the software, composing equipment, cannot 

produce them or printers used in producing the manual, such as 

the symbol for ohm, infinity, etc. 

A.4.7.7 Metric and U.S. standard measurements. Unless specified 

otherwise by the acquiring activity, all measurements should be 

expressed in both U.S. standard units (e.g., ounces, pounds, 

gallons, inches, feet, knots, miles, etc.) and metric units. 

U.S. standard measurements should be followed by the metric 

conversion in parentheses unless the equipment, instrument, or 

tool, etc., is calibrated in metric units. In that case, metric 

units should be first, followed by the U.S. standard units. 

(For example, "169.5 Nm (125 lb-ft)".) 

A.4.7.8 Temperature. Reference should be made to temperature 

readings as calibrated on the equipment. If other than 

Fahrenheit, the equivalent in Fahrenheit should follow in 

parentheses. General temperature references, such as room 

temperature, should be given in degrees Fahrenheit (for example, 

78°F). 

A.4.7.9 Other IETMs. When it becomes necessary to reference to 

other work packages, descriptive information, maintenance tasks, 

or other data contained in another IETM, it should be by the 

IETM number, as a minimum. The reference should be linked when 

the referenced data is on the same CD or within the CD set for 

the system. 

A.4.7.10 Tables. Tables should be linked to the appropriate text 

and displayed when they do not already appear in the graphics 

client area on the user's EDS or viewer. 

A.4.7.11 Figures. Figures should be linked to the appropriate text 

or index number and displayed when they do not already appear in 

the graphics client area on the user's EDS or viewer. 

A.4.7.12 Index numbers. Unless specified otherwise by the 

acquiring activity, figure and index numbers should be used in 

text to identify items and parts on illustrations. For example, 

41 Enclosure (4)


“Remove safety disc (fig. 1, item 3) and safety disc 

washer (figure 1, item 4) from valve body (fig. 1, item 

2).” 

A.4.7.13 Items on diagrams. Reference should be made to parts on 

diagrams by enough of their description or reference designator 

to identify the item (for example, resistor A6R11). 

A.4.8 Multimedia presentation. Audio, video, and animation 

techniques should only be used in an IETM when it results in 

enhancing the presentation of the information or makes the 

procedures more effective. Every instance used should be 

discussed with and approved by the acquiring activity before any 

audio, video, or animation presentation is included in an IETM. 

Multimedia standards to be used for presentation techniques 

should be specified by the acquiring activity. 

A.4.9 Portraying signal flow. Signal flow, especially for 

electrical and electronic equipment, critically affects the 

understandability of diagrams. To assist the IETM user in 

following the diagram, where possible, major signal or pressure 

flow should be from left to right, and feedback or return flow 

should be from right to left. Animation or color may be used to 

indicate signal flow. 

A.4.10 Color in illustrations. Color may be used when it will 

enhance the understanding of the data. The use of some colors 

may not be appropriate for certain environmental conditions. 

The following color limitations should apply. Red should not be 

used if the IETM will be used in red light conditions such as in 

a tank or shelter. For IETMs that may be displayed on a 

monochrome system, reverse video and/or underlining should be 

used for hot spots rather than color. The use and choice of 

colors should be as specified by the acquiring activity. 

A.4.11 Revisions for IETMs. 

a. Each revision to an IETM should be identified by a revision 

date. 

b. When updates to an IETM are made, the entire IETM should be 

revised and reissued. 

c. When an IETM is revised and reissued, revision summary 

information should be included. 

A.4.12 Revision symbols. Revision symbols should be inserted to 

identify technical updates in text, illustrations, and tables. 

a. Updates to the text and tables should be indicated by a 

vertical line (revision bar) opposite the updated, deleted, 

or added text (except as noted below). If the composing 

Enclosure (4) 42


equipment is incapable of producing a vertical line, 

another symbol may be used as specified by the acquiring 

activity (for example, a number sign "#;" plus sign "+;" 

black circle; black square; the letters "C," "R," or "X"). 

d. When tables are updated or added, the revision bar should 

also be placed to the left of the table title. 

e. Revision symbols from a previous revision should be deleted 

when a frame is subsequently updated. Symbols should show 

current updates only. 

d. Revision symbols are not required for correction of minor 

inaccuracies, such as spelling, punctuation, relocation of 

material, renumbering, etc., unless such correction changes 

the meaning of the information. 

e. A revision symbol such as a "C" should be included for each 

revised work package in the list of contents. 

f. A revision symbol such as a "C" should appear with the work 

package title in the title bar area. 

A.4.13 Revision symbols for illustrations. Unless specified 

otherwise by the acquiring activity, a miniature pointing hand 

should be used for illustrations (other than diagrams and 

schematics) to highlight the area containing the revised 

information. 

a. Revisions confined to the same general area should be 

indicated only once on the illustration. 

b. A vertical line next to revised callouts on illustrations 

may be used in lieu of a pointing hand. 

c. A vertical line next to revised material may be used on a 

chart or graph. 

d. As specified by the acquiring activity, screens (shading), 

screened (shaded) boxes, or miniature pointing hands should 

be used to highlight updated areas of diagrams and 

schematics. 

e. When a figure has a figure title, a vertical line should be 

placed to the left of the figure number title. 

A.4.14 Style guidelines. Style guidelines refer to the following 

categories: The nature of the language structure, vocabulary, 

and criteria governing technical terminology, numbers, and 

abbreviations. The presentation related aspects of text, 

graphics, and audio information. 

A.4.15 Format guidelines. 

43 Enclosure (4)


A.4.16 User interaction and features. 

A.4.16.1 General user interaction. General user interaction 

capabilities for interactive presentation of IETMs are functions 

needed to control a screen display and functions, which are used 

to interact with the IETM. Also, functions such as a method to 

obtain information for example help, next and back. The user 

interface needs to be easy for the technician to understand and 

navigate. The IETM should be intuitive enough to aid the 

technician through maintenance tasks and supply all available 

information necessary in an efficient manner. The IETM should 

also be consistent throughout the entire IETM presentation 

process. 

A.4.17 Graphic guidelines. IETMs rely heavily on graphics to 

communicate to the technician. Consequently, the construction 

of high-quality graphics represents one of the most stringent 

and important concerns in IETM preparation. Graphics should be 

as simple as possible and displayed in a format that conveys the 

complete thought to the user. When graphics accompany text, 

they should be designed so that they illustrate and are 

consistent with actual points. 

A.4.18 Graphic display. Graphic displays should be consistent and 

maintain a standard format, for example level of detail, 

relationship to text and other graphics, labeling and callout 

labeling. Consistency in the display of graphics should allow 

the user to focus on the graphics rather than being distracted 

or confused by changes in format. Graphics should provide only 

the data necessary for user tasks. 

A.4.19 Display characteristics/colors. When developing an IETM, 

developers should use the MIL-HDBK-511. This IETM developers 

guide further refines the information within that documents. 

A.4.20 Text colors / background. The text should be black 

(#000000 or #000033) except as noted elsewhere. Background 

should be white (#FFFFFF) except as noted elsewhere. This aids 

printing without loss of content. There may be operational 

exceptions such as night ops and where color has special 

meaning. Use of the safe color palette (see Inner Shell Colors 

in the previous section) avoids surprises upon fielding to 8-bit 

devices such as PDAs. 

A.4.21 Standard text/fonts. Table A-1 provides guidelines for 

font standardization of IETMs delivered to the end-user. 

Enclosure (4) 44


Electronic 

Presentation 

Hardcopy 

Presentation 

TABLE A-1. Standard IETM fonts. 

Normal Font 

Minimum Size 

Fixed Font (if 

needed) 

Normal Font 

Minimum Size 

Fixed Font (if 

needed) 

Arial 

Eight (8) points 

The minimum size for electronic presentation is 

8pts. (This is 8 pts). Don’t use anything 

smaller. This is 6pts. 

Courier New 

Arial or Times New Roman 

8 points 

Courier New 

A.4.22 Front and rear matter. Information that is normally 

considered part of the front and rear matter but are typically 

not part of the table of contents should be accessible from the 

IETM’s table of contents or the user navigation panel. A 

revision summary component should be established from a link on 

the user navigation panel to provide information with links to 

where data has changed, and to describe any IETM functional and 

cosmetic feature changes. 

A.4.23 Revision summaries. Revision summaries when required by an 

acquiring activity should be accessed via the table of contents. 

When a subsequent revision is prepared, the previous revision 

summary should be removed and only the new revision information 

should be provided. The user should have the option to view 

revision markings within the revised IETM. 

A.4.23.1 Revision markings. Revision markings to distinguish 

changed information should be indicated by a vertical bar 

opposite the updated, deleted, or added text. Revision bars are 

not needed on screen but may be added in the printed copy. 

A.4.24 Hot spots/links. 

A.4.24.1 Text links. Text hot spots should be visually indicated. 

When highlighting text for selectable elements (hot spots), 

color may be used to indicate changes or increase in background 

intensity. Unvisited links may be indicated in red underlined. 

There should be an indication that the hot spot has been 

followed. 

A.4.24.2 Hotspots in graphics. There are four acceptable modes of 

visual indication of hot spots. 

a. Persistent visual indication that an area is hot. 

b. Cursor changes shape or color when cursor is over hot 

spotted area. 

45 Enclosure (4)


c. Object changes shape or color when cursor is over hot 

spotted area. 

d. Pop-up appears while cursor is over hot spotted area. 

A.4.24.3 Hot spots in tables. Only the referencing text within a 

table cell should be hyperlinked. Do not link the entire cell. 

Reference to a table cell or row should scroll directly to the 

referenced cell or row. 

A.4.24.4 Links to graphics and tables. To view figures or tables, 

when not in-line, use one click of text that is blue underlined 

initially and turns purple underlined after followed. 

References to in-line objects would bring up the graphic in a 

separate panning/zooming window for viewing. Generally 

speaking, buttons are not really needed and therefore are 

optional. Buttons would most likely be used in place of the inline 

graphic for large HTML files with many graphics to speed up 

initial loading. TOC links should all be one click. 

A.4.24.5 Links to multimedia. Links to view animations, videos, 

etc. should use one click of text that is blue underlined 

initially and turns purple underlined after followed. Just like 

tables and figures, the links should include type, number, and 

title (e.g., 'See Video 7-3, Disassembly Procedures'). Icons may 

also be used for non-text references. 

A.4.25 User interface. The user interface guidelines for session 

control, context filtering, state handling, browsing, etc. for 

highly interactive IETMs are provided in 7.3.8 through 7.3.12. 

A.4.25.1 Session control. Session control is the ability to stop 

and start an IETM session in the middle of work. This involves 

saving the state of the session for later reload to re-establish 

the user session back to where it was before the interruption. 

IETMs should support the ‘complete’ (save and update history 

file) and ‘suspend/resume’ functionality. The ‘abort’ should 

only be allowed in ‘browse’ mode on the end-user client. When 

specified the requiring activity, the following functionality 

should be provided. 

a. The ability to suspend a session at any time (e.g., for a 

break or emergency) should be provided. 

b. A resume function should be capable of re-starting the 

session at the same point it was suspended. 

c. At the time of resume, the user should be advised that some 

key parameters/condition settings may be out-of-date. 

d. The system should support the three exit modes. 

(1) Complete (save and update history) 

Enclosure (4) 46


(2) Abort (don’t save or update history) 

(3) Suspend (see a. above) 

A.4.25.2 Bookmarks and annotations. Bookmarks provide the ability 

to mark areas of interest to allow quick access. Annotations are 

the ability of the system administrator or user to place special 

notes within an IETM. These could be public information for all 

users such as special information that requires rapid deployment 

to the manual holders like “Advance Change Notices”, or they 

could be private notes needed only by the user to assist in 

their training. Table A-2 provides recommended functions and 

icons that should be part of the annotation function. 

a. There should be a persistent visual indication that an 

annotation exists. 

b. The default initial presentation of annotations should 

appear minimized. 

c. If there are levels of annotations (e.g., public, private, 

etc.), they should be visually differentiated. 

Table A-2. Recommended icons for annotations and bookmark 

functions. 

ANNOTATION 

PUBLIC 

Icon 

PRIVATE 

Icon 

LOCATION 

Redline ----- 

Create Bookmark --- Local Nav Utilities Bar 

Note: Ask whether creating 

or navigating to Bookmark 

Goto Bookmark Local Nav Utilities Bar 

Note: Ask whether creating 

or navigating to Bookmark 

If navigating to bookmark, 

update the “TOC” and the 

“Main” Areas to reflect 

destination 

Bookmark 

minimized 

Main/Full-Main Area 

Note: Indicates Location is 

Create User 

Note 

Book marked 

---- Local Nav Utilities Bar 

47 Enclosure (4)


ANNOTATION 

User Note 

minimized 

PUBLIC 

Icon 

PRIVATE 

Icon 

LOCATION 


Action: Selecting opens User 

note as a pop-up 

Minimize/Exit Exit Pop-up with Pop-up 

User Note “Close” Button 

Create Comment --- Local Nav Utilities Bar 

Comment 

minimized 


Action: Selecting opens 

Minimize/Exit 

Comment 

Exit Pop-up with 

“Close” Button 

comment as a pop-up 

Pop-up 

Enclosure (4) 48


APPENDIX B 

EXAMPLE IETM CONOPS LAYOUT 

B.1 SYSTEM INTRODUCTION. Provide a brief introduction to the 

system, its configuration and how the IETM should be supported. 

B.2 SYSTEM ATTRIBUTES. 

B.2.1 Complexity of System. Provide description and maintenance 

concept for the system. Describe use of built-in test systems, 

fault isolation features and techniques for troubleshooting. 

B.2.2 Configuration Volatility. Where necessary different IETMs 

may be required to support various system/equipment 

configurations. When configuration volatility exists, the 

CONOPS should describe those volatilities and the steps 

necessary to overcome them. 

B.2.3 Classification and Security. The IETM should not contain 

classified data, where necessary the IETM should reference 

documents containing the appropriate classified data. 

B.2.4 Expected Service Life. Describe the expected service life 

of the system or equipment. Also, provide any expected update 

and interval for those updates. 

B.2.5 Number and Deployment Systems. Provide information on the 

number, location, and sites where the system will be deployed. 

Location characteristic and operating environments should also 

be included. 

B.2.6 Number of IETM Users. Describe the number of IETM users the 

intended system is to support. Provide details such as 

requirements for printing and display characteristics. 

Additional information on IETM licenses and cost of maintaining 

the IETM should be provided. Information on the intended users 

should also be provided. Information such as level of 

technician, skills required and support personnel required 

should be provided. 

B.2.7 Quantity of Data. Provide details on the source data for 

the IETM and how much data will be generated. 

B.2.8 Quality of Data. Describe the integrity and quality of the 

source data and expected quality of the final IETM data. 

Provide any information on additional quality improvement 

measures that may be required. 

B.2.9 Consolidation of Subject Matter. Describe the initial scope 

of coverage in the IETM and what future releases will contain. 

Describe whether future releases will include enhancements or be 

significantly different than the first release. 

49 Enclosure (4)


B.2.10 Maintenance Levels. Describe and provide the level of 

maintenance that the IETM should support. Describe what 

features are available in the IETM that supports or aids 

testing, fault isolation and troubleshooting of the system. 

B.2.11 Training Levels. Describe whether the IETM will need to 

support any training requirements. When training information is 

required describe the training data that will be included in the 

IETM. Also, forecast any training schedules that may be 

required to support the IETM. 

B.2.12 Manning Requirements. In most cases the IETM should reduce 

the amount of manning required to support systems. When 

additional manning or reduction in manning is required they must 

be addressed in the CONOPS. 

B.2.13 Existing Government and Contractor Infrastructure. Describe 

whether current government and contractor infrastructure exists 

to support the IETM. Provide details on limitations by the 

government or contractor that need to be compensated for. 

Describe how the government and contractor should overcome 

limitations to support the creation, maintenance and update of 

the IETM. 

B.2.14 IETM Implementation Schedule. Provide the details on the 

how the IETM should be implemented. Describe the IETM 

implementation schedule including the Comprehensive IETM Plan. 

Describe the time frame from proof of concept, actual IETM 

development and in-process reviews. 

B.2.15 Urgency of Information Update. Describe the process for 

direct updating of IETMs and the role of the government and 

contractor in this process. 

B.2.16 Security. Provide the restrictions under which classified 

information should be access in the IETM. 

B.2.17 Display Hardware, Operating Systems, Networks and 

Compatibility. Determine the display hardware, operating 

systems and network capabilities required for the IETM. 

Describe the network operating environment and compatibility 

issues that users may face when using the IETM. 

B.2.18 Environmental Conditions and IETM Display Hardware. 

Describe the environmental hazards and operating conditions that 

the IETM display should be operating under. For example high 

noise levels, dirt, water, salt, light levels, heat, grease or 

long hours of operation. 

Enclosure (4) 50


B.2.19 Display Hardware maintenance and Support. Describe whether 

any conditions impact on display hardware or necessitate 

additional maintenance support. 

51 Enclosure (4)


Detailed S1000D, MIL-STD-3001, Extensible Markup Language 

(XML), and TMCR Information 

S1000D 

1. S1000D is a non-government specification. It’s titled the 

International specification for technical publications utilizing 

a common source database. 

a. This Specification has been produced to establish 

standards for the documentation of any civil or military vehicle 

or equipment. It is based on international standards such as 

SGML/XML and CGM for production and use of electronic 

documentation. 

b. In addition, it defines a Common Source Data Base (CSDB) to 

provide source information for compilation of the publications 

and for use in electronic logistics information systems to 

deliver modules of information direct to the user. 

2. The specification and associated DTDs are available at the 

S1000D web site at: http://www.s1000d.org/ 

MIL-STD-3001 

1. MIL-STD-3001 is an eight-part Standard with three 

appendices. The technical content, style and format 

requirements contained in MIL-STD-3001 may be used to develop 

and assemble complete aircraft weapon systems, aeronautical 

equipment, airborne weapons/equipment, and support equipment TMs 

for any level of maintenance through depot. Its functionality 

permits display of page-oriented, scrollable ETM, and framebased 

IETMs on an electronic display system (EDS) or for output 

of paper TMs. MIL-STD-3001 also includes: 

a. TM selection and technical requirement tailoring 

capability using technical content selection matrixes are 

provided in Appendix A. 

(1) Appendix A also supplies a reference capability to each 

technical content requirement by part and paragraph number. 

(2) The reference capability points to a related MIL-STD- 

3001 paragraph with a referral to an indicator that identifies 

if a requirement is mandatory or optional. 

1 Enclosure (5)


b. Style and format and front matter requirements that are 

needed to assemble and print complete work package paper and 

digitally displayed page-style TMs are provided. 

c. Style and format (“look and feel”) and front matter 

requirements for the display of linear structured, scrollable 

ETMs, and frame based IETMs are provided. 

2. MIL-STD-3001 Parts –1 thru –8 consolidate, standardize, and 

supersede the requirements contained in the following documents: 

a. MIL-M-23618 Military Specification, Manuals Technical, 

Periodic Maintenance Requirements, Preparation and Printing of. 

b. MIL-M-81218 Military Specification, Manuals Technical, 

Aircraft Engine Intermediate and Depot Maintenance, 

Preparation of (Work Package Concept). 

c. MIL-M-81700 Military Specification, Manual Technical, 

Airborne Armament Equipment, Requirements for. 

d. MIL-M-81701 Military Specification, Manuals Technical, 

Airborne Missiles and Guided Weapons, Preparation of. 

e. MIL-M-81702 Military Specification, Airborne Weapons 

(Conventional), Requirements for. 

f. MIL-M-81919 Military Specification, Manuals Technical, 

Support Equipment, Preparation of (Work Package Concept). 

g. MIL-M-81927 Military Specification, Manuals Technical, 

General Style and Format of (Work Package Concept). 

h. MIL-M-81928 Military Specification, Manuals Technical, 

Aircraft and Aeronautical Equipment Maintenance, Preparation of 

(Work Package Concept). 

i. MIL-M-81929 Military Specification, Manuals Technical, 

Illustrated Parts Breakdown, Preparation of (Work Package 

Concept). 

j. MIL-M-85383 Military Specification, Manuals Technical. 

Aircraft Structure Repair, Corrosion Control, and Nondestructive 

Inspection, Preparation of (Work Package Concept). 

k. MIL-M-85707 Military Specification, Manual Technical, 

Depot Maintenance Requirements for Maintenance/Demilitarization 

of Airborne Weapons (Conventional), Requirements for. 

Enclosure (5) 2


3. MIL-HDBK-3001 is a guidance only manual providing preferred 

style and format for both paper and ETM/IETM requirements and 

associated examples consistent with DON Policy on Digital 

Logistics Technical Data. 

a. Supplies additional details and explanations for “must do” 

or mandatory ETM and IETM needs contained in MIL-STD-3001. It 

also provides additional Look and Feel information. 

b. Identifies further definitions and solutions for MIL-STD- 

3001 requirements. This includes how to develop an outline for 

a Technical Manual Program, extra data necessary for developing 

Common Look and Feel front matter, and examples of technical 

content work packages. 

c. Provides examples of how various technical content 

information may be displayed on the screen and illustrates 

typical techniques for navigation through different the 

displayed technical data. 

4. A MIL-STD-3001 Tool Kit is also available providing the 

following: 

a. Modular DTD(s) for each functional part of the standard 

with XML tags installed in the requirements to aid authors in 

the tagging process. 

b. An assembly DTD to produce a complete manual. 

c. A Formatting Output Specification Instance (FOSI) to 

permit the formatting and printing of paper TMs in work package 

format. 

d. A style sheet to provide navigation and look and feel 

requirements for display on the NAVAIR IETM Viewer. 

Extensible Markup Language (XML) 

1. XML is the NAVAIR markup language of choice. It facilitates 

a wide variety of Web uses and can greatly improve viewer 

communication. 

a. An XML technical data application, such as MIL-STD-3001, 

uses a Document Type Description (DTD). The DTD is an XML data 

construction tool for identifying structure and content of the 

type of document to be created. Additionally, it supplies 

definitions and markup rules for applying XML in authoring 

processes. 

3 Enclosure (5)


b. TMs, ETM, and IETM XML formatted deliveries to NAVAIR 

shall include an XML source file and entity files. 

(1) An XML source file consists of TM text with installed 

XML tags. The XML source file will be stored and kept in a 

TMAPS repository or a database in NATEC. 

(2) Entity files are connected with an XML source file and 

may be created and referenced by the DTD. Usually, entity files 

are designed when there is standard text in a document that will 

be used or shared among instances of a class of documents. 

Contents of entity files are available to any document using a 

connecting DTD. Instances are actually marked-up textual data. 

(3) FOSIs are used in conjunction with the applicable DTD 

to provide for the formatting and printing of paper TMs in work 

package format. 

(4) Style sheets are used in conjunction with the 

applicable DTD to provide for the look and feel and certain 

navigation capability for the computer display of IETMs. 

(5) A description of how XML tags are used can be found in 

the DTD Data Dictionary. 

(6) The Tagging Conventions document is used as an aid in 

tagging and developing a XML source file for a NAVAIR TM. 

c. An ETM is a TM normally prepared from a linear Standard 

Generalized Markup Language (SGML) or an XML document file. The 

ETM is also displayed on an Electronic Display System (EDS) in a 

sequential or document oriented manner. The data author largely 

predefines the sequence of data presentation. It is an 

organization of technical data that replicates the order of 

information found in a page-based document. There is generally 

a default “path” through the technical data. The ETM may employ 

a combination of an automated intelligent index and linked 

reference data. 

d. An IETM is a technical manual prepared in digital form and 

designed for interactive display by means of a computer 

controlled EDS. The information is not displayed in a 

sequential fashion. The organization of content does not follow 

a document or page-based paradigm. There are high levels of 

interactivity between the data and the user. The order of 

presentation is dictated by inputs from the user, external 

sources, or events (as in diagnostics). There may be multiple 

paths through the data. Individual paths through the data are 

Enclosure (5) 4


generally determined based on user input. Displayed information 

may be presented in a scrollable format when the information to 

be displayed will not fit the size of the screen display. 

TMCR Requirements 

1. The following guidelines are for use with MIL-STD-3001. 

S1000D TMCR requirements will be developed and addressed upon 

development of S1000D business rules. These requirements are 

guidelines only and will need to be tailored for specific 

program needs. For further amplification refer to NAVAIR-00-25- 

601. The technical content and style and format requirements 

contained in MIL-STD-3001 are used to develop and assemble 

complete aircraft weapon systems, aeronautical equipment, 

airborne weapons/equipment, and support equipment TMs. These 

requirements are used to develop and assemble complete TMs for 

any level of maintenance through depot. The requirements are 

applicable for the display of page-oriented, scrollable ETM and 

frame-based IETMs or for the output of paper TMs. 

2. When contractually invoked, the following parts of MIL-STD- 

3001 shall be cited as applicable: 

MIL-STD-3001-1 Preparation of Digital Technical Information 

for Multi-Output Presentation of Technical Manuals; 

Appendix A-Technical Manual Content Selection Matrixes 

Appendix B-Preparation Requirements for Page-Oriented 

Technical Manuals 

Appendix C-Preparation Requirements for Frame-Based and 

Scrollable Technical Manuals 

MIL-STD-3001-2 Description, Principles of Operation and 

Operation Data 

MIL-STD-3001-3 Testing and Troubleshooting Procedures 

MIL-STD-3001-4 Maintenance Information With Illustrated 

Parts Breakdown (IPB) 

MIL-STD-3001-5 Aircraft Wiring Information 

MIL-STD-3001-6 Structural Repair Information 

MIL-STD-3001-7 Periodic Maintenance Requirements 

MIL-STD-3001-8 Illustrated Parts Breakdown (IPB). 

5 Enclosure (5)


3. MIL-HDBK-3001, Guide to the General Style and Format of U.S. 

Navy Work Package Technical Manual, supplements the requirements 

of MIL-STD-3001. It provides detailed examples of preferred 

presentation “look and feel” for screen display of scrollable 

ETM and frame-based IETM consistent with the NAVAIR Instruction, 

Functionality And Common Look And Feel Requirements For NAVAIR 

Interactive Electronic Technical Manuals (IETMS). The handbook 

should be used in conjunction with MIL-STD-3001. MIL-HDBK-3001 

can be cited on contract as a reference only. 

Enclosure (5) 6

NAVAIR INSTRUCTION 4120.11 From: Commander, Naval Air ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?