2019_Feb_EVA_TMCR_update_3_(002)_signed.pdf

TMCR NO. 17-006

Date: 09JUN2017

TECHNICAL MANUAL CONTRACT REQUIREMENT (TMCR)

SUBJECT: ENHANCED VISUAL ACUITY, OPERATOR MANUAL

SOURCE DATA AND MAINTENANCE MANUALS

ACQUISITION ACTIVITY: NAVAIR, Aircrew Systems PMA202, Patuxent River Maryland

CONTRACTOR: TBD

CONTRACT NUMBER: EVA EDM

DISTRIBUTION STATEMENT C: Distribution authorized to U.S. Government agencies and their contractors, Administrative or Operational Use, 07 February 2019. Other requests for this document shall be referred to Commander, Naval Air Systems Command (PMA202) 21491 Great Mills Road, Suite 202, Lexington Park, MD 20653-1394.

PREPARED BY: Stephen Batten, EVA DAPML

PMA202

NATEC QA CHANEY.DAVID.DUANE.10703563 Digitally signed by CHANEY.DAVID.DUANE.1070356372 DN: c=US, o=U.S. Government, ou=DoD, ou=PKI, ou=USN, cn=CHANEY.DAVID.DUANE.1070356372

REPRESENTATIVE:72 _ Date: 2018.12.03 12:45:06 -05'00' _ _

DAVID CHANEY DATE

PRIMARY

SUPERVISOR: _ _ 11 Feb 2019

Charles Dixon PMA-202 PSM DATE

1.0 Scope

TABLE OF CONTENTS

2.0 Program Phase and Period of Performance

3.0 Applicable Documents

4.1 Technical Manual Development

4.2 Technical Manual Information Maintenance Level

4.3 Approved Maintenance Plan

4.4 Type of Acquisition

4.5 Types of Technical Information to be Developed

4.6 Additional Technical Manual Data

4.6.1 General Series TM Information

4.6.2 Commercial Off-The-Shelf (COTS) TMs

4.6.3 Government Furnished Information (GFI) for TM

4.7 Technical Manual Information in Printed Format

4.8 Technical Manual Content Outline

4.8.1 Content Coverage

4.8.2 Additional Content Information

4.8.3 Product Coverage

4.9 Functionality Requirements

4.10 Quality Assurance Requirements

4.10.1 Total Quality Assurance Requirements

4.10.2 TM Quality Assurance Program Plan

4.10.2.1 The QAPP

4.10.3 Technical Manual Initial Guidance Conference and QA Program Planning Conference

4.10.3.1 Conferences

4.10.3.2 Initial Guidance Conference

4.10.3.3 It should be noted

4.10.4 Technical Manual Content Outline Reviews

4.10.5 Validation

4.10.6 Contractor Validation Plan

4.10.7 Re-inspection, re-validation, or re-review

4.10.8 Validation Plan

4.10.8.1 Validation Methods

4.10.8.2 Detailed Review

4.10.9 Validation Records

4.10.10 Validation Certification

4.10.11 Adequacy Reviews

4.10.12 Quality Reviews

4.10.13 Quality Records

4.10.14 Corrective Action

4.10.15 Acceptability Reviews

4.10.16 Verification

4.10.17 Combined Validation/Verification

4.10.18 In-Process Reviews (IPRs)

4.10.19 Scope and Depth

4.10.19.1 Review and approve final TM Product Plan/Outline

4.10.19.2 Perform the following for all completed Work Packages

4.10.19.3 Check for Adequate and Accurate PDF Bookmarks

4.10.19.4 Check that Placeholders for WPs Not Developed

4.10.19.5 All Applicable IRACs, TMERs and TDs

4.10.20 Second and Subsequent IPRs

4.10.21 Additional Quality Assurance Guidance

4.11 Contractor Configuration Control

4.12 Data Rights

4.13 Copy Rights

5.0 General Requirements

5.1.1 Status Reports

5.1.2 Information to be Reported

5.2 The LEM and DAPML Points of Contact

5.3.1 LEM

5.3.2 DAPML

5.3 Government Furnished Documents/Software

5.4 Software Interoperability

5.5 Transmittal Instructions

5.5.1 DD-250s

5.5.2 Deliverables

5.6 Classification Information

5.6.1 Higher Classified Information

5.7 Duplication of Data

5.8 Notification of Delay in Delivery

5.9 Distribution Statements and Other Markings

5.9.1 Distribution Statement

5.9.2 Export Control Notice

5.9.3 Destruction Notice

5.9.4 Authority Notice

5.10 Technical Publications Deficiency Reports (TPDR) Management

6.1 Deliverables

6.2 PDF

6.3 CD-ROMS

6.4 Delivery of Revisable Master

7.0 Technical Manual Size Restriction (Hardcopy)

Attachments

Technical Manual Validation Certificate MIL-STD-3001 Technical Content Requirements Tables IPR Review Execution Criteria Tables (4) QA Checklist for Printed/PDF Technical Manuals (MIL-STD-3001 and MIL-DTL-81310) Classification of Defects Technical Manual Evaluation record (TMER)

1.1 Scope. The requirements contained in this Technical Manual Contract Requirement (TMCR) apply to all technical manual (TM) information required for the support, operation, and maintenance of the Enhanced Visual Acuity, hereafter referred to as EVA.

• ORGANIZATIONAL AND INTERMEDIATE MAINTENANCE WITH ILLUSTRATED PARTS

BREAKDOWN, ENHANCED VISUAL ACUITY

• DEPOT MAINTENANCE WITH ILLUSTRATED PARTS BREAKDOWN, ENHANCED VISUAL

ACUITY (if Organic Depot is Required)

• THE OPERATOR MANUAL SOURCE DATA WILL BE COMPRISED:

1. Operating procedures for the helmet mounted equipment.

2. Warnings, Cautions, and Notes applicable to the operation and handling of the equipment.

3. System limitations and situations that could limit flight profiles etc.

2.0 Program Phase and Period of Performance. The period of performance for this Engineering Development Contract is outlined in the Program Milestone Schedule. It begins at contract award and continues through final delivery and acceptance.

3.0 Applicable Documents.

MIL-STD 3001A V3.07a Toolkit MIL-STD-3001-DoD Standard Practice Digital Technical Information for Multi-Output Presentation of Technical Manuals, Illustrated Parts Breakdown (IPB), Part 1– Part 8 MIL-PRF-85337B(AS) Performance Specification, Manuals, Technical, Quality Assurance Program MIL-PRF-28001C, Performance Specification, Markup Requirements and Generic Style Specification for Exchange of Text and Its Presentation MIL-PRF-32216 Performance Specification Evaluation of Commercial Off-The-Shelf (COTS) Manuals and Preparation of Supplemental Data

Other Government Publications

NAVAIR 00-25-604, NAVAIR Systems Command Fleet Support/Integrated Program Team Acquisition and Sustainment of NAVAIR Technical Manuals DOD 5220.22-M, National Industrial Security Program Operating Manual SECNAV M-5510.36, Department of the Navy Information Security Program Don Policy on the use of extensible markup language (XML) NAVAIR Systems Command Policy on Size Limitation for Digital Manuals Posted to the NATEC Website, 4000 Ser 6.8.5/0085 S0005-AA-PRO-010/TMMP Operations and Life Cycle Support Procedures Manual AL-855TM-GYD-000 Technical Manual Quality Assurance (TMQA) Program Guide NAVAIR 00-25-100, NAVAIR Systems Command Technical Publications Library Management Program MIL-HDBK-9660 DoD Handbook, DoD Produced CD-ROM Products DoDD 5230.24, Distribution Statements on Technical Documents

Non-Government Publications or Standards

ISO 9000 series Quality Management and QA Standards Program (NMCI) Gold Disk (latest version)

4.1 Technical Manual Development.

4.2 Technical Manual Information Maintenance Level. The TM(s) information developed for the EVA shall support operation and maintenance at the Levels of Maintenance determined by the EVA Maintenance Plan (LSA-024).

4.3 Approved Maintenance Plan. All data contained in the technical manual shall reflect the system or equipment represented in accordance with the approved Logistical Product Data (LPD) Maintenance Plan/Support Equipment Recommendation Document.

4.4 Type of Acquisition. The TM(s) being developed under this TMCR is for the EVA, which is a

Engineering Development System. The TM(s) referenced in para 1.0 shall be developed/updated IAW MIL-STD-3001 format requirements.

4.5 Types of Technical Information to be developed. The following types of TM information set shall be developed in accordance with MIL-STD-3001.

• Operation and Maintenance Instructions with IPB Manual (MIL-STD- 3001,Table A-XXIX)

4.6 Additional Technical Manual Data.

4.5.1 General Series TM(s) Information. Existing General Series technical manual information applicable to the EVA shall be identified/referenced as required.

4.5.2 Commercial Off-The-Shelf (COTS) TMs. All COTS TMs applicable to the EVA shall be acquired in accordance with MIL-PRF-32216. All COTS TMs applicable to the EVA shall be referenced. All COTS TMs as part of this TMCR shall have an Acceptability Review performed by NATEC QA prior to acceptance.

4.5.3 Government Furnished Information (GFI) for TM(s). GFI applicable to the EVA to be included:

• TM # NA 13-1-X.XXXX will be provided once manual quantity and type are established.

4.6 Technical Manual Information in Printed Format. The TM(s) developed under this TMCR shall be provided in a printed format in accordance with MIL-STD-3001. Technical manual information prepared in a work package structure and delivered digitally in accordance with this standard shall be XML-tagged using modular Document Type Definitions (DTDs). All other technical manual information required by 4.4 above will be provided as a Maintenance Instructions and Operating Instructions.

NOTE: An XML-tagged source file is composed of the applicable WP technical content in XML-coded ASCII, marked up (tagged) in accordance with the applicable modular DTD. In order to tag WP text appropriately, the author inserting the tags should be familiar with the DTD or should provide the text file to a person who is experienced with the DTD and who understands the type of documentation being written, especially when content tags are used.

• The modular DTDs referenced in MIL-STD-3001 interpret the technical content and structure for the functional requirements contained in this standard and are mandatory for use.

• The DTDs, and associated tag and attribute descriptions, which are XML constructs, may be obtained from the requiring activity.

4.7 Technical Manual Content Outline. The TM Content Outline indicating the breakdown of the manual(s) in accordance with the MIL-STD-3001 shall be submitted to the Government IAW CDRL A01A. The detail level and contents of the outline shall be determined by the program. A list of all technical manuals shall be included as part of the TM Outline for the EVA.

4.7.1 Content Coverage. The outline shall provide specific technical content. The plan shall include total technical content coverage for each system, subsystem, equipment, and major component, as applicable. For each system, subsystem, equipment, and major component, the outline shall include proposed Work Packages (WPs) for the following types of data:

• WPs for descriptive data (for example, description, theory of operation, use of controls and indicators)

• Procedural WPs necessary to operate the system

• Procedural WPs necessary to perform complete maintenance

• WPs for testing and troubleshooting

• Schematics and wiring information required

• Parts information coverage (IPB)

• Additional supporting information

• Preparation for Use and Assembly, Handling, Stowage, Removal, Disassembly

Cleaning and Corrosion Control Inspection

4.7.2. Additional content information. The following additional information shall be included in the plan, as applicable.

• Include data for the front matter, depending on the type of output.

• For this TMCR, Appendix A of MIL-STD-3001, Table A-XXIX contains matrixes that list all applicable technical content requirements for the development of a complete Organizational and Intermediate Level Operations and Maintenance Technical Manual.

4.7.3 Product Coverage. The plan shall include contractor recommendations for:

• Use of COTS and/or other TMs, included, excluded, or referenced

• General Series TMs

4.8 Functionality Requirements: The minimum mandatory functionality requirements indicated by the check marks in the functionality matrix table shall be implemented in the TM(s) developed for the ET System. The contractor has the option of proposing additional functional requirements from those identified in the matrix. Additional functionality proposed by the contractor must be explained in the technical manual content Outline. For a detailed definition of the functions provided in the functionality matrix, refer to NAVAIRINST 4120.11. Refer to the following table for PDF functionality requirements:

Functionality Matrix Table

4.9 Quality Assurance Requirements. The contractor shall participate in a Total ISO 9000 Series Quality Assurance Program.

4.9.1 Total Quality Assurance Requirements. The contractor shall develop, implement and enforce a Quality Assurance Control Program that encompasses the following Quality Assurance (QA) requirements. QA requirements shall be provided in the contractor’s Technical Manual Quality Assurance (TMQA) Program Plan. The contractor will demonstrate the TMQA Program Plan to the Government/NATEC QA Representative at the Initial Guidance Conference. The Government may also inspect the product to be prepared hereunder at various stages of development.

4.9.2 TMQA Program Plan. The contractor shall prepare and maintain a Quality Assurance Program Plan (QAPP) which shall describe the scope and approach of the TMQA Program Plan. The QAPP will be submitted to NATEC QA, via the Contract Administration Office (CAO), for approval, in accordance with the time schedule established in this TMCR. At a minimum, the plan shall include a description of the following elements.

• Contractor’s Organization

• Quality Reviews

• Quality Records

• Corrective Action

• Database Control

• Control of subcontractors and vendors

• Sampling Plans

• Classification of Defects (CD) development

• Qualifications of employees involved in TM development

4.9.2.1 The QAPP will be reviewed for approval by NATEC QA, which will provide written notice of approval or disapproval, via the CAO, within 45 days after receipt of the QAPP.

4.9.3 Technical Manual Initial Guidance Conference and QA Program Planning Conference.

The Technical Manual Initial Guidance Conference may be held in conjunction with the Post Award Conference. The conferences will normally be scheduled as soon as possible after contract award or when the contractor or Government deems the conference necessary to ensure adequate understanding of contractually applied Quality Assurance requirements. The specific guidance required will determine the necessity of holding a joint guidance and quality planning conference, separate conferences, or one conference exclusive of the other.

4.9.3.1 Conferences should only be conducted if required (e.g., When the contractor indicates a complete understanding of all requirements, the conference requirements should be waived). NATEC Quality Assurance is responsible for determining the necessity of a conference when requested by the contractor or Government.

4.9.3.2 The Technical Manual Initial Guidance Conference is scheduled after contract award to provide guidance to contractors as follows:

• A preparing activity's initial (first) effort on work package format manuals.

• In response to a justified request by the preparing activity or the Government.

• The extent of guidance will be tailored to the specific requirements of each separate Guidance Meeting.

• The contractor shall provide a technical writer and an individual to act as recorder for all scheduled reviews.

4.9.3.3 It should be noted that Guidance Conferences are convened to provide guidance to contractors early in their TM programs relative to preparation of TM products. Contractors are recommended to adequately prepare for such conferences, to ensure guidance to the required depth.

4.9.4 Technical Manual Content Outline Reviews. The TM Outline shall be reviewed for content and compliance during the Initial Guidance Conference. If the Outline requires modification or is rejected, the unacceptable portions shall be corrected and resubmitted. For Technical Manual Content Outline Requirements, refer to paragraph 4.7.

4.9.5 Validation. Validation is a contractor quality assurance responsibility which is to be accomplished for all TMs, changes, and revisions thereto. The Government will not accept data that has not been validated. Also, the Government may witness validation on a non-interfering basis and may be required to sign the validation certificate when authorized by Defense Contract Management Agency (DCMA). A TM will not be considered validated until the following conditions have been fulfilled:

• Contractor's engineering technical review has been completed.

• Information reflects configuration of the systems and equipment and includes all engineering changes.

• Procedural instructions are readily understandable by the intended user and adequate to perform all operations and maintenance functions.

• Adequacy of data is checked to ensure that it supports the approved maintenance and support plan.

• Hardware of the proper configuration is available for the validation effort.

• All operation, maintenance, troubleshooting and parts information can be easily accessed from the bookmarks/table of contents and that the navigation and logical sequencing through the information is manageable and user friendly.

• All technical information, including text, tables, and graphics appear in the appropriate data panes in accordance with the requirements provided in MIL-STD-3001.

• As part of the validation process, the contractor shall develop a validation plan, validation records and provide the Government with validation certification.

4.9.6 Contractor Validation Plan. It is the responsibility of the contractor to develop a validation plan that is acceptable to the Government. It should reflect compatibility with the overall maintenance and support plan, outline the contractor’s recommended validation procedure, and indicate the scope of the validation effort. The validation plan should also include the identification of manuals for which requirements have yet to be defined, such as equipment component and support equipment manuals and how they are to be integrated with the TMs that will be developed and delivered. The plan should include recommendations for simultaneous validation and verification, or separate verification, as appropriate. The validation plan should ensure there is a system for inspection, validation, and correction of the TM. The validation process will provide a measure of the overall quality of the TM. When the Government performs an inspection at a contractor's plant, such inspection must not be used by the contractor as evidence of effective control of quality.

4.9.7 When revisions or corrections are required after any inspection, validation, or review, there will be re-inspection, re-validation, or re-review required by the contractor, and if necessary, by the Government, of all data affected.

4.9.8 The Validation Plan should include:

4.9.8.1 Validation methods which the TM will be tested for technical adequacy, accuracy and compliance with the provisions of the specifications and other technical contractual requirements.

4.9.8.2 Detailed review of the final deliverable TM to ensure that this material is identical to the authorized, validated, verified and corrected TM.

4.9.9 Validation Records. The contractor is required to maintain records of all validations performed. These records will indicate the affected manuals, weapon system, component, part number, or serial number. The records need to be made available for Government review.

4.9.10 Validation Certification. The contractor is required to prepare a Validation Certification IAW CDRL A01B attesting to the TM adequacy and accuracy by actual performance or simulation. Individual validation certification reports are to be prepared for each TM validated by the contractor, using NAVSEA/SPAWAR 4160/3 (12-93), (See Attachment) as the certification document and shall be prepared in accordance with NAVAIR 00-25-604 concurrent with delivery of the technical/source data. Requests to deviate from requirements in NAVAIR 00-25-604 shall be documented by the Contractor and forwarded to the NATEC QA Representative (via the LEM) for approval/disapproval. Corrections and significant comments resulting from validation need to be incorporated prior to issue of the validation certification.

4.9.11 Adequacy Reviews. Adequacy reviews are formal reviews conducted by the Government to examine Maintenance Manuals and Illustrated Parts Breakdowns (IPBs) simultaneously. The specific objective of Adequacy reviews is to determine if the depth and scope of coverage in maintenance manuals/IPBs is sufficient to support repairables, replaceables, and items to be assembled or manufactured at the approved NAVAIR maintenance level(s). Adequacy reviews are normally conducted concurrent with the in-process reviews (IPRs). Adequacy reviews can also be conducted during verification.

4.9.12 Quality Reviews. The contractor’s QA organization is required to conduct internal quality reviews to ascertain compliance with the technical manual QAPP and provide for corrective action. Quality reviews are to be conducted to evaluate the availability and adequacy of materials, processes, procedures, and intermediate products which constitute TM development. Sampling plans should be as specified in the TMQA Program Plan.

4.9.13 Quality Records. The contractor is required to maintain objective records of all quality reviews. The contractor’s compliance is determined by the accuracy, currency, and the completeness of records as specified by the acquiring activity and the technical manual QAPP. Objective evidence is demonstrated by the ease of retrieval of specific information from records and their accuracy, currency, and completeness at the time of the Government representative's request. The records document quality problems and disposition recommendations and adequately identify the items in the TM to which the comments and recommendations apply.

4.9.14 Corrective Action. The contractor is required to initiate a process of corrective action for all recorded and detected deficiencies. The contractor should implement preventive action programs to counter any apparent deficiency trends. The detection of deficiencies, which are recognized and are not cited in the Classification of Defects (CD), should be added to the CD in the Technical Manual QAPP. Objective evidence of the effectiveness of the corrective action program for each deficiency should be maintained.

4.9.15 Acceptability Reviews. Acceptability reviews are conducted on Commercial off-the-shelf (COTS) manuals and Non-NAVAIR approved manuals. COTS manuals are manuals that support equipment designed and manufactured for commercial use and normally include operation, maintenance and other instructions for the commercial equipment. In the event that commercial equipment is used in a military environment, the COTS manuals must adequately reflect the hardware and maintenance concept for the weapon system program. Therefore, it is the responsibility of the contractor to review the manuals for adequacy and technical content in accordance with MIL-PRF-32216. If the COTS document fails to meet the criteria set forth in MIL-PRF-32216, supplementary data will be required to be written to ensure that all maintenance information is provided to the end user. Non-NAVAIR approved manuals are technical manuals that are approved for use by other Naval System Commands, including Marine Corps and other services (Army/Air Force/Coast Guard).

4.9.16 Verification. When specified by the acquiring activity, verification will be accomplished under the jurisdiction of the Government and may include contractor support.

Verification is a responsibility of the approval authority or authorized representative. The purpose of verification is to ensure that the contractor's products and services are in conformity with the requirements of this TMCR.

4.9.17 Combined Validation/Verification. In extenuating circumstances, the Government may authorize a combined validation/verification be conducted at an operational site. In this situation, the Navy assumes control of the validation/verification effort. When a combined validation and verification is to be conducted at a Government site, a separate validation is conducted by the contractor and the validation comments are incorporated into the data followed by a separate verification conducted by the Government.

4.9.18 In-Process Reviews (IPRs). IPRs will be authorized and convened as deemed necessary by the Government. The contractor is responsible for supporting IPRs and providing access to TM materials, intermediate and final products. At a minimum, IPRs include evaluation of source data, Technical Manual Product Outline. The Contractor shall make the following source data available, to include but not limited to: TDP, LPD, TPDRs, IRACs, TDs, etc. Required Government personnel for IPRs may include a NATEC Technical Representative, NATEC QA, Fleet Sailors, Engineers, a Maintenance Planner and the DAPML. Required Contractor personnel shall include or be made available for all IPRs:

Engineer(s) and Tech Writer. Contractor shall provide an overhead, CD-ROM and/or paper copies of TMs for each individual attending the IPRs and any additional resources required.

IPRs may be conducted by the NATEC QA representative IAW the Review Execution Criteria Tables (See Attachments) and CDRL A01A.

In Process Review Entrance

. Operation and Intermediate Maintenance Instructions with IPB Manual shall be submitted IAW CDRL A01A

. Execution Criteria IAW TMCR Tables 1-5 must be met

In Process Review Closure

. In Process Review (IPR) successfully conducted

. Technical Manual Evaluation Records (TMERs) for all Technical Manuals have been approved and verified by the Government

. Completion Letter from NATEC Quality Assurance issued and received

4.9.19 The Government and the contractor shall agree on the scope and depth of each of the required IPRs. At a minimum, the following requirements shall be demonstrated at the initial IPR: Refer to Table 1, First Review Execution Criteria attached.

4.9.19.1 Review and approve final Technical Manual Content Outline

4.9.19.2 Perform the following for all completed work packages:

• Work package technical information is in accordance with MIL-STD-3001 style and format requirements for printed TMs.

• Required personnel, required referenced documents and WPs, support equipment, consumable materials, and technical directives are included and displayed properly.

• All WP cross-reference links are active and working correctly.

• All referenced tables and illustrations are inserted correctly.

• Technical content is accurate and adequate

• Format and editorial check.

4.9.19.3 Check for adequate and accurate PDF bookmarks.

4.9.19.4 Check that placeholders have been provided for all WPs that have yet to be developed.

4.9.19.5 All applicable IRACs, TMERs and TDs have been or will be incorporated.

4.9.20 Second and Subsequent IPRs. At a minimum, the following requirements shall be demonstrated during the second and subsequent IPRs. Refer to Tables 2-4, Second, Third and Final Review Execution Criteria, attached.

• Ensure that all deficiencies found during the prior IPRs have been corrected.

• For all publications and work packages not previously reviewed, repeat all IPR checks performed during the prior IPRs.

4.9.21 Additional Quality Assurance Guidance. Additional guidance for the IPR requirements described above, is provided in the QA Requirements Work Package in

NAVAIR 00-25-604.

4.10 Contractor Configuration Control. The contractor shall ensure the positive control of configuration and change records. Control of data shall include, but not be limited to, data resulting from urgent/safety changes (RACs/IRACs), Technical Directives (TDs), Class I and II Engineering Change Proposals (ECPs) and Technical Publications Deficiency Reports (TPDRs). Details how the contractor digitally tracks the source data being incorporated in the TM shall be maintained.

Changes shall be provided concurrent with data update deliveries. A succinct digital list of data shall be available to the Defense Contract Management Activity (DCMA) QA Representative and incorporated. This list shall also indicate the location of data updates to allow QA to review the incorporated changes. The contractor shall maintain and update as required for TM update for the duration of the contract.

4.11 Data Rights. Government rights in data are specified in the Defense Federal Acquisition Regulation Supplement (DFARS). Contractor shall provide Government with Unlimited Rights for all source data and TMs prepared specifically for the EVA.

4.12 Copy Rights ©. Publications should not contain copyrighted material except as specified in the Federal Acquisition Regulations (FAR) and Defense Federal Acquisition Regulation (DFAR)

Supplement. When copyrighted or proprietary material is included in a publication, the author shall obtain prior written permission from the copyright owner or authorized agent for its use. The signed, written permission shall contain a statement declaring whether or not a copyright credit line is required. When a copyright credit line is required, the following information shall appear in the <copyright>|<copyright> element of the DTDs: "This document contains copyright or proprietary materials. Infringement of copyright or proprietary material may violate existing Federal laws and statutes and result in criminal penalties, imprisonment, or removal from office."

5.1 General Requirements.

5.2 Status Reports. Technical Manual Status Reports shall be conducted in accordance with CDRL A01A and SOW para.4.3.1.

5.2.1 Information to be reported. The Contractor shall be required to participate in teleconference meetings as needed throughout the length of this contract to discuss technical manual development status and logistics issues or concerns.

5.3 Logistic Element Manager (LEM) and Deputy Assistant Program Manager for Logistics (DAPML) shall both be the points of contact for coordination of all matters relating to the publications prepared hereunder.

5.3.1 The LEM. The Technical Publications Logistics Elements Manager (LEM) designated by the NAVAIR Logistics Competency’s Technical Manual Lead (6.8.5) is:

Name:

Activity Name:

Rod Esquivel

PMA202, 6.8.5.1

Address: 47056 Mcleod RD, B446 Patuxent River, MD 20670-1632

Phone Number:

E-mail:

(301) 995-7325 Rod.Esquivel @navy.mil

5.2.2 The DAPML is:

Name:

Activity:

Address:

Phone Number:

Stephen Batten NSWC Crane 300 HWY 361 Bldg 3324 Crane In 47522-5001

(812) 854-5018

Mobil Number:

E-Mail:

(812 508-5157 steve.batten@navy.mil

5.4 Government Furnished Documents/Software. If required, contractor shall apply for and obtain an account for the Technical Manual Application System (TMAPS) for managing various TM functions. TMAPS is available on the NATEC website at https://mynatec.navair.navy.mil.

5.5 Software Interoperability. All software/software versions required for electronic technical manual distribution and presentation shall be as identified in the Navy/Marine Corps Intranet (NMCI) Gold Disk (latest version), or be an approved Navy Functional Area Management (FAM) product.

5.6 Transmittal Instructions. Material furnished under this TMCR shall be delivered to the DAPML with DD Form 250 for inspection and acceptance.

5.6.1 DD-250s: The DD-250s for final TM manual delivery shall identify the total number of units delivered, the number of affected units, and the TMCR under which the delivery requirement was established. An affected unit shall be defined as any delivered unit in a changed issue other than back- ups and blanks. In the case of a “re-issue”, pages delivered solely for re-issue purposes shall be considered back-up. All pages delivered during revision shall be considered affected with the exception of blanks. The DD-250s for TM deliveries shall identify the TMCR under which the delivery requirement was established.

5.6.2 Deliverables: The deliverables under this TMCR, including back-up pages, reproduction assembly sheets and Electronic Media, shall be packed in accordance with mailto:brenda.divincenzo@navy.mil mailto:rene-joel.daclan@navy.mil best commercial practice for contractor transmittal to the DAPML with DD Form 250 for inspection, acceptance and the preparation of print orders for printing and distribution of printed copies.

5.7 Classification Information. All classified documents shall be marked as required by DoD 5220.22-M, National Industrial Security Program Operating Manual, as implemented by SECNAV M-5510.36, Department of the Navy Information Security Program.

5.7.1 Where higher classified information would comprise ten (10) percent or less of the basic manual's content and would be concentrated in one area of the manual, such information shall normally be prepared as a classified supplement, permitting the basic manual to be issued at a lower classification or as an unclassified publication. The respective title pages of both the basic manual and the supplement shall contain a cross-reference note to each other. NATEC approval is required for each supplement.

5.8 Duplication of Data. The contractor shall ensure that there will be no costs in this contract for technical data already developed and further ensure that requirements contained in the TMCR /order do not duplicate data generated by other tasks or data requirements being furnished by this contractor under other Navy contracts. This data, i.e., Logistics Product Data (LPD), engineering data and such other data as may have been previously furnished, shall be utilized to the maximum extent possible as source data for the technical manuals to be furnished under this contract and the unit prices shall not include development costs for previously acquired data. In addition, the contractor shall utilize existing TMs provided by the Government to determine if technical manual data required for this program already exists.

5.9 Notification of Delay in Delivery. In the event the Contractor cannot meet the delivery schedule of any technical manual information cited in this Contract and/or applicable order issued under this Contract, the LEM, DAPML and CAO shall be notified immediately of the delay. This notification, at a minimum, shall include the reason for the delay, corrective action(s) and a proposed new delivery schedule, etc.

5.10 Distribution Statements and Other Markings.

5.10.1 Distribution Statement. All technical manuals shall have a distribution statement placed on the title page. Distribution Statement C will be utilized.

5.10.2 Export Control Notice. Publications with export controlled data shall be marked with an export control notice provided by the acquiring activity from DoD 5230.24.

5.10.3 Destruction Notice. All technical manuals shall be marked with the destruction notice provided by the acquiring activity from DoD 5230.24.

5.10.4 Authority Notice. The publishing approval authority statement should be presented in capital letters on the title page or frame as follows:

"PUBLISHED BY DIRECTION OF THE COMMANDER, NAVAL AIR SYSTEMS COMMAND"

5.11 Technical Publications Deficiency Reports (TPDR) Management. The Contractor shall incorporate all Government adjudicated/approved existing TPDRs as well as any additional TPDRs that are generated throughout the Period of Performance of this contract. TPDR updates apply to those Technical Manuals identified in para 1.0 of this TMCR. TPDRS shall not be incorporated without prior Government approval.

6.1 Deliverables. The contractor shall deliver the following:

• Technical Manual Content Outline, forwarded to the DAPML (PDF and MS Word) in accordance with MIL-STD-3001-1A, Appendix A, 30 days after Post Award.

• Validation Certificate

• Validation Plan

• Complete PDF of required printed technical manual(s).

• Source files used to produce the PDF document.

• PDF of TM Changes only or PDF of complete TM Revisions.

• Delivery of Revisable Master (The XML source file, all associated illustrations, the MIL-PRF-

28001 formatted PDF and MS Word)

6.1 PDF shall be prepared from the revisable master (i.e., authoring source file) and shall be delivered on ISO 9660 compliant CD-ROMs for all publications.

6.2 CD-ROMs shall be clearly dated and marked to indicate the content contained on the media.

Labels shall indicate whether there is more than one media item in the series, i.e., “Disk 1 of 3”, etc. All media shall be marked and handled with appropriate security classification level in accordance with DoD 5220.22-M, National Industrial Security Program Operating Manual, as implemented by SECNAV M-5510.36, Department of the Navy, Information Security Program.

• The CD-ROM shall contain a README.txt file containing instructions for opening, viewing and printing the files, as guided by this manual and ISO-660. The CD-ROM shall contain an index.txt file containing the following data in tabular form from left to right:

- Publication Identification Number

- Publication Date

- Publication Title

- Publication Revision Level

- File Name(s), Format(s), and File Date(s)

• For Changes, when directed by the TM LEM or DAPML, the CD-ROM shall include both a completely collated file of the manual with current changes, a Change Package consisting of only the current changed pages including XML File, all illustrations/drawings and all files associated with TM. This will facilitate print and distribution of paper changes by the TM LEM as required.

• For Revisions, the CD-ROM shall include only a collated file of the manual with current changes incorporated and all files associated with TM.

• Any special printing instructions shall be forwarded with the files at time of delivery. The following are examples of special printing instructions: odd size paper (i.e., not 8 1/2” x 11”) and list of affected pages, etc.

6.3 Delivery of Revisable Master (PDF, MS Word and XML). The Contractor shall deliver to the DAPML/LEM IAW CDRL A01A, the following:

• Digital revisable master files (XML tagged instance(s) and graphics and reusable object files) of the technical manual information. The revisable source shall reflect the latest issue of the technical manual information.

7.0 Technical Manual Size Restriction (Hardcopy). New manuals and revisions to existing manuals, furnished under this contract, shall not exceed three inches in thickness. Manuals exceeding the three-inch limitation shall be volumized. The determination of the necessity for volumization of changes to existing manuals that exceed the three-inch limitation shall be coordinated with NATEC's Data Manager.

Attachments

TECHNICAL MANUAL VALIDATION CERTIFICATE

TECHNICAL MANUAL TITLE

TECHNICAL MANUAL IDENTIFICATION NUMBER DATE

CONTRACT/TMCR NO.

I - VALIDATION

Except as stated in II, the technical manual identified above has been satisfactorily validated in accordance with all requirements of the applicable TMCR and the approved Validation Plan. The technical manual is hereby certified to be accurate and complete, and the information, instructions, text, and illustrations conform in all respects to the applicable general and detailed specifications.

II - EXCEPTIONS

EXCEPTIONS AUTHORIZED BY

(Brief Description and References) (Government Representative Name/Code)

SIGNATURE OF CONTRACTOR'S PUBLICATIONS

QUALITY ASSURANCE OFFICER

DATE

NAVSEA/SPAWAR 4160/3 (12-93)

MIL-STD-3001-1A (AS)

TABLE A-XXIX. OPERATION AND MAINTENANCE INSTRUCTIONS WITH IPB MANUAL

(AERONAUTICAL EQUIPMENT, AIRBORNE WEAPONS/EQUIPMENT, AND SUPPORT EQUIPMENT)

TM CONTENTS

MIL-STD-3001

REFERENCE

ELEMENT

NAME

REQUIRED/

NA

TM FRONT MATTER AND SUPPORTING

INFORMATION

Title page Numerical index of effective work packages/pages

(A page) TPDR page

HMWS WP

Alphabetical index WP Numerical index of part numbers work package Numerical index of reference designations work package Introduction WP Consolidated lists for technical directives, support equipment, materials and references WP

1-B.5.3.1

1-B.5.3.1.1

1-B.5.3.1.2 1-B.5.3.1.3 1-B.5.3.1.4 1-B.5.3.1.5 1-B.5.3.2.1.3.1

1-B.5.3.2.1.3.2 1-B.5.3.2.1.3.3

1-B.5.3.2.1.3.4

<titlepg> <niewp>

<tpdrpg>

<hmwswp> <alphaindxwp> <partnoindxwp> <refdesindxwp>

<introwp>

<consolistwp>

R

R R

WORK PACKAGE FRONT MATTER

Title block Work package information

Reference material list Record of applicable technical directives Support equipment required list Facilities required list Materials required list

2-5.2.1 2-5.2.2 2-5.2.2.1 2-5.2.2.2 4-5.2.2.3 4-5.2.2.4 4-5.2.2.5

<titleblk> <wpinfo> <reflist> <ratd>

<selist> <faclist> <matlist>

R R R R R

DESCRIPTION AND PRINCIPLES OF

OPERATION WPs

Description WPs Introduction System description Subsystem description Component description Controls and indicators description

Programming software description work packages Introduction Stimulus and measurement

Programming Programming statements Programming tests or self-tests Principles of operations WPs

Introduction System description Subsystem description Component description System principles of operation

2-5.2.4, 2-5.2.5 2-5.2.4.2.2 2-5.2.4.2 2-5.2.4.2.2 2-5.2.4.2.2 2-5.2.4.2.2 2-5.2.4.2.1.1 2-5.2.4.2.4 2-5.2.4.2.4

2-5.2.5.2 2-5.2.5.2 2-5.2.4.2.2 2-5.2.4.2.2 2-5.2.4.2.2 2-5.2.5.2

<descwp> <intro>

<sysdesc> <sysdesc> <sysdesc>

<ctrlinddesc> <softwp>

<stim-measdesc>

<statedesc> <progtestdesc>

<popwp> <intro>

<sysdesc> <sysdesc> <sysdesc> <systhry>

R R R R

NA

R R R R R R

SCHEMATIC DIAGRAM WORK PACKAGES

Introduction

2-5.2.5.4, 3-5.3.4.6.1 2-5.2.5.4

<schemwp>

OPERATION DATA

Operating instruction WPs

Introduction

2-5.2.6 2-5.2.6.1 2-5.2.6.1

<operwp>

(AERONAUTICAL EQUIPMENT, AIRBORNE WEAPONS/EQUIPMENT, AND SUPPORT EQUIPMENT)

Equipment preparation for use Pre-operational setup procedures Start-up procedures Controls and indicators descriptions Built-in-test or self-test procedures Operating procedures Emergency operation Emergency shutdown procedures Post-operational shutdown procedures

Software loading WPs

2-5.2.6.1a 2-5.2.6.1b 2-5.2.6.1c 2-5.2.6.1d 2-5.2.6.1e 2-5.2.6.1f 2-5.2.6.1g 2-5.2.6.1h 2-5.2.6.1i 2-5.2.6.2

<prepuse> <preop> <startup>

<ctrlinddesc> <bit-st-op> <op-proc>

<emerg-proc> <emshut-proc> <post-op-proc>

<softldwp>

R R R R R R R

NA

R R

TESTING AND TROUBLESHOOTING DATA

Testing and troubleshooting WPs

Testing WPs Introduction General procedures and precautions Pretest setup procedures Testing procedures Post-testing shutdown procedures

Troubleshooting WPs

Introduction General procedures and precautions Troubleshooting procedures Post-testing shutdown procedures

Combined testing and troubleshooting WPs

Introduction General procedures and precautions Pretest setup procedures Testing and troubleshooting procedures Post-testing shutdown procedures

3-5.1, 3-5.1.3, 3-5.2

3-5.3.5 3-5.3.4.6.3 3-5.3.4.6.3a 3-5.3.4.6.3b 3-5.3.4.6.3c 3-5.3.4.6.3d 3-5.3.4.6.3e

3-5.3.4.6.4 3-5.3.4.6.4a 3-5.3.4.6.4b 3-5.3.4.6.4c 3-5.3.4.6.4d

3-5.3.4.6.5 3-5.3.4.6.5a 3-5.3.4.6.5b 3-5.3.4.6.5c 3-5.3.4.6.5d 3-5.3.4.6.5e

<opchkwp>

<genproc> <pretest> <opchk>

<shutdown> <emergshtdn> <trblshtwp>

<intro> <genproc> <trblsht>

<shutdown> <emergshtdn> <tst-trblwp>

<intro> <genproc> <pretest>

<opck-trblproc> <shutdown>

<emergshtdn>

R R R R R R R R R R R R R R R R R R

MAINTENANCE INFORMATION WITH IPB

Maintenance work packages

Introduction Maintenance tasks

Preparation for use and assembly

Handling

Stowage Removal

Disassembly

Cleaning and corrosion control

Inspection

4-5.3 4-5.3.1 4-5.3 4-5.3.1.1 4-5.3.1.1a, 4-5.3.1.1.2 4-5.3.1.1b, 4-5.3.1.1.3 4-5.3.1.1c 4-5.3.1.1d, 4-5.3.1.1.4 4-5.3.1.1e, 4-5.3.1.1.5 4-5.3.1.1f, 4-5.3.1.1.6 4-5.3.1.1g, <maintwp>

<prepuse>

<handling>

<stow> <remove>

<dissam>

<clncorr>

<insp>

(AERONAUTICAL EQUIPMENT, AIRBORNE WEAPONS/EQUIPMENT, AND SUPPORT

EQUIPMENT)

Service Repair

Alignment Painting Lubrication Assembly

Test and inspection

Installation

Rigging Adjustment Calibration

Preparation for storage or shipment

Environmental conditioning Safety information

Engine start and run-up

Software loading Fabrication

Packing Unpacking Preservation Tracking Fueling Defueling Canning Decanning

General maintenance procedures work package Support equipment maintenance work package

Local manufacturing and assembly work package IPB data (as applicable for WPs listed above) Wiring/cabling diagram WP Wire run lists WP

4-5.3.1.1.7 4-5.3.1.1h 4-5.3.1.1i, 4-5.3.1.1.8 4-5.3.1.1j 4-5.3.1.1k 4-5.3.1.1l 4-5.3.1.1m, 4-5.3.1.1.9 4-5.3.1.1n, 4-5.3.1.1.10 4-5.3.1.1o, 4-5.1.1.1.11 4-5.3.1.1p 4-5.3.1.1q 4-5.3.1.1r, 4-5.3.1.1.12 4-5.3.1.1s, 4-5.3.1.1.13 4-5.3.1.1t 4-5.3.1.1u, 4-5.3.1.1.14 4-5.3.1.1v, 4-5.3.1.1.15 4-5.3.1.1w 4-5.3.1.1x, 4-5.3.1.1.16 4-5.3.1.1y 4-5.3.1.1z 4-5.3.1.1aa 4-5.3.1.1ab 4-5.3.1.1ac 4-5.3.1.1ad 4-5.3.1.1ae 4-5.3.1.1af 4-5.3.2 4-5.3.5

4-5.3.6 4-5.3.11 4-5.3.12 4-5.3.13

<service> <repair>

<align> <paint> <lube>

<assem>

<test-inspect>

<install>

<rig> <adjust>

<calibrate>

<pss>

<envircond> <safe>

<engstart>

<softload> <fabricate>

<packing>

<unpacking> <preserve>

<track> <fuel>

<defuel> <canning>

<decanning> <genmaintwp> <semaintwp>

<locmfgwp>

<ipb> <wirediawp> <wirelistwp>

R

NA

NA

NA

NA

NA

Table 1. First Review Execution Criteria

Non-Technical Structure and Format

All sections/work packages have been created. Type size and font, numbering, indexes, etc is well-defined.

Title Page Includes Pub number, Release Date, Distribution

Statement, and Destruction Notice.

List of Effective Pages (Front Matter / Introduction Pages)

Coordinate with NATEC QA and obtain the appropriate language for specification being used for “generic” reuse in manual.

Safety Summary General safety instructions, Warnings, Cautions, Notes, Hazardous Materials Warnings, Icons, and Descriptions are included and identified by use of an icon, nomenclature, and specification or part number of material.

Principles of Operation Basic outline exists including a brief physical description, the function and purpose of the equipment. Information is provided in a logical functional flow, to include flowcharts, functional diagrams, etc.

Technical Installation, Removal and Maintenance Instructions

Basic outline of the procedural steps for Installation, Removal, and Maintenance have been written IAW provided source data.

Checkout and Troubleshooting Basic outline of the procedural steps for Checkout and

Troubleshooting have been written IAW provided source data, to include decision trees, fault isolation, BIT, etc.

Illustrations(Graphics) All schematics/diagrams/illustrations/artwork matches the written technical data provided. Quality of Illustration style and technique is such that produces artwork that is clear, adequate, economical, and accurate.

Parts Lists / Illustrated Parts Data (IPD)

Table 2. Second Review Execution Criteria

Must have a completion letter stating successful completion of all prior reviews(All TMERS from prior reviews shall be incorporated)

Structure and Format Structure and format of all Non-Technical sections/work packages is compliant with specification and (all) business rules. Section/work packages now require only final Quality Assurance (QA).

Front Matter complete, requirements identified and suggested inspection cycle established (if applicable).

Title Page

All information is complete and in compliance with specification and program specific requirements.

Safety Summary

All safety summaries included and verified with current NAVAIR instructions. All HAZMAT shall be in accordance with NAVAIR Aviation Hazardous Materials List (AHML) (If HAZMAT listed is not included on the NAVAIR AHML, it will not be authorized for use).

Principles of Operation All Principles of Op data complete and ready for final QA.

Technical

Installation, Removal and

Procedures have been reviewed for technical accuracy and compliance with government task requirements.

Checkout and Troubleshooting Procedures have been reviewed for technical accuracy and compliance with government task requirements.

Illustrations(Graphics)

All diagrams/illustrations/artwork included in manual and arranged in a logical functional order and properly indexed. Some changes or modifications may still be required.

Parts List / IPD are properly Indexed, with correct Part Numbers, Descriptions, Units Per Assembly, Usable On Codes, and SM&R Codes. Data in the Parts List / IPD adequately reflects the technical information within the manual.

Table 3. Third Review Execution Criteria

Must have a completion letter stating successful completion of all prior reviews.

Structure and Format 100% Complete.

Title Page 100% Complete.

100% Complete.

All information is complete.

Safety Summary HMWS Complete

Principles of Operation 100% Complete.

Technical All hyperlinks (if included) are in place and working All Operating and maintenance procedures are safe for

Integrated Test.

Installation, Removal and

100% Complete.

Checkout and Troubleshooting 100% Complete.

Illustrations(Graphics) 100% Complete.

Table 4. Fourth Review Execution Criteria

Must have a completion letter stating successful completion of all prior reviews.

Structure and Format 100% Complete.

Title Page 100% Complete.

100% Complete.

All information is complete.

Safety Summary HMWS Complete

Principles of Operation 100% Complete.

Technical All hyperlinks (if included) are in place and working All Operating and maintenance procedures are safe for

VAL/VER.

Installation, Removal and

Checkout and Troubleshooting 100% Complete.

Illustrations(Graphics) 100% Complete.

100% data completed, to include any data found as a result of Integrated testing

Table 5. Final Review Execution Criteria

Must have a completion letter stating successful completion of all prior reviews.

All remaining content and TMERs incorporated.

Contractor Validation Certificates received IAW 00-25-604

100% of data completed, to include any data found as a result of TM Verification and

MDEMO.

QA CHECKLIST

FOR PRINTED/PDF

TECHNICAL MANUALS

(MIL-STD-3001 and Legacy Specifications)

Publication Number:

Publication Title:

Issue Date:

Name of Reviewer: Date:

A. ITEMS THAT MAY BE NEEDED

1. Adobe Acrobat Reader (for PDF)

2. XML files for verifying proper tagging and resolving discrepancies; graphic files;

PDF or printed TM

3. Technical Manual Contract Requirements (TMCR) including Project Functionality Matrix

4. Technical Manual (TM) Content and Product Plan (TM Outline)

5. Quality Assurance (QA) Program Plan

6. Original source data

7. Applicable Specifications/Standards and Handbooks

8. Text editor for viewing XML (e.g., Epic Editor, Notepad, WordPad, etc.)

B. TECHNICAL CONTENT

1. Ensure that warning or caution is placed before the applicable step

2. Verify that all Support Equipment, Reference Material, Materials Required, and Record of Technical Directives within a WP are listed at the beginning of the WP (if applicable)

3. Ensure the appropriate security classification is assigned, and classified material is properly identified (if applicable)

4. Ensure the committed source data (e.g., TPDRs, IRACs, etc.)

is properly incorporated

5. Check that proper warnings and cautions are provided for hazardous materials

6. Check that all material is authored to the level defined by the…