The Truth about Technical Manuals

Dan PappasPappas Consulting, LLC

Technical Manuals

Technical Manuals (TMs) are the culmination of science/engineering and logistics analysis.

A well-written and properly-planned TM will enable users to: Order parts; Fault isolate to the failed part; and Perform functional tests in order to

determine whether or not that part is properly working.

Input Criteria for TM Development Typical entrance criteria are:

Provisioning to the LRU; Task analysis for all maintenance and

operations; Level of Repair Analysis (LORA); and Failure Mode Effects and Criticality Analysis

(FMECA).

When the entrance criteria are not met, TM development fails.

Hierarchy of Development A TM can only communicate information

that is available; as such: Adequate technical manuals require

adequate logistics analyses. Adequate logistics analyses require adequate

engineering/scientific discovery. The Configuration Managed (CM) article must

be based on logical, top-down functional and physical breakdown architecture that supports each Configuration Item (CI).

The Only Plausible “Work Around” In lieu of adequate information

discovery, it is possible to achieve an 80% solution by way of S1000D techniques. While this will not represent the support

posture required for subject equipment, it will identify support solutions.

Ultimately, arbitration of extraneous information objects will be necessary as the actual support posture is exercised.

The TM Skill Set

The criticality of equipment operator or maintenance Subject Matter Experts (SMEs) cannot be overstated. The SME’s skill set should support the TM’s

function; i.e., an Operations versus a Maintenance TM.

The SME must be capable of performing reverse engineered work around or classic Task Analysis.

The SME must be capable of articulating technical data in a clear and concise manner.

The Classic Writing Approach A competent technical writer must be capable of

assessing the subject in the following manner: Describe the high-level system and its function; Describe the physical assembly, to include system-

and part-level integration; Discuss the inputs necessary for the system to

operate; e.g., electricity, fuel, oxygen, etc.; Identify equipment modes and functions; Describe how modes and functions are achieved, as

well as how, for example, signal flow supports other functions; and

Clearly and concisely articulate operations and/or maintenance procedures to a less technical audience.

The TM Skill Set, cont…

For effective TMs, another critical skill set is provisioning. Technical writers and system SMEs may not be well versed in this technique.

A competent analyst can: Ascertain the equipment’s top-down functional and physical

breakdown; Determine Level of Repair for both the system and its parts

in accordance with the organization’s support structure; Identify required materials, tools, and other support

equipment; Report hardware at the proper indenture level; and Design illustrations that enable the reader to make better

decisions.

The TM Skill Set, cont…

Finally it is necessary for an illustrator to illustrate the manual with: High-level equipment placement

drawings; Controls and indicators; Block diagrams; Schematics; and Functional and Physical Breakdowns.

Other TM Skill Sets

Today, with the advent of Interactive Electronic Technical Manuals (IETMs), Technical Writers may be required to possess IETM capabilities such as: Data Design; XML/XSLT Scripter; and Specialized application knowledge; e.g.,

Arbortext and Adobe FrameMaker and InDesign.

Other TM Skill Sets, cont… For document builds, Data Designers

must know how to assess the following: Business rules:▪ Specified Content; e.g., MIL-STD or Contractor

Format▪ Regulations; e.g., OSHA, FAR, FAA, and NRC

Content object definition; If/Then Logic for decision processes; and File type compatibility.

Other TM Skill Sets, cont… In addition, an XML/XSLT Scripter

must be well versed in the mechanics of the ASCII Syntax.

This XML language is a hierarchical ASCII syntax that must adhere to specific structures for the deliverable to be high quality.

Syntax Context must be maintained in order to compile the final instance.

The Final Solution There are many solutions for TM development;

among them: Finding the correct mix of skill sets is essential; Determining if the Input criteria exists is essential; Developing sound processes that increase product

value and reduce cost; The ability to make these discoveries, liaison with

engineering, and coordinate the effort is ultimately key to success; and

Reliance on seasoned professionals to plan and manage a TM or IETM project from concept to completion to eliminate or mitigate project risks.