Attachment D SOW RSC Tech Manual Contract Requirement.docx

TMCR NO. NDMS-080027-000

Date: 20 November 2007

TECHNICAL MANUAL CONTRACT REQUIREMENT (TMCR)

ACQUISITION ACTIVITY: NSWC, PHILA

Commanding Officer NSWC, PHILADELPHIA 5001 S. Broad Street Philadelphia, PA 19112-1403

CONTRACTOR: CONTRACT NO.: 1 5

DISTRIBUTION STATEMENT A: APPROVED FOR PUBLIC RELEASE; DISTRIBUTION IS UNLIMITED.

This document prescribes the Technical Manual format, style, technical content, preparation, and delivery requirements. Instructions and guidance are provided to assist Technical Manual preparers in the development of accurate, adequate, comprehensible, and usable technical documentation that conforms to and complies with established NAVSEA policy.

This document is effective upon receipt and supersedes all previous information and instructions, regardless of source, related to the preparation of a NAVSEA Technical Manual for the subject equipment. Conformance with the requirements specified are mandatory. No changes or waivers are authorized without the express written NAVSEA approval.

PREPARED BY

COMMANDER

NAVAL SURFACE WARFARE CENTER DIVISION NAVAL SYSTEMS DATA SUPPORT ACTIVITY

4363 MISSILE WAY

PORT HUENEME, CA 93043-4307

BY DIRECTION OF

NAVAL SEA SYSTEMS COMMAND (SEA 04L)

Directory Table of Contents Figure List Text

TABLE OF CONTENTS

PARAGRAPH PARAGRAPH TITLE

1.1 DELIVERABLES.

1.2 TECHNICAL MANUAL SCHEDULE, STATUS AND COSTS REPORTS.

1.3 QUALITY ASSURANCE PROVISIONS.

1.3.1 Validation Plan.

1.3.2 Validation Certification.

1.4 MANUAL, TECHNICAL, STANDARD.

1.4.1 Review Draft Copy (RDC).

1.4.2 Final Reproducible Copy (FRC).

1.3.2.1 Final Digital Encoding of Technical Publications.

2.1 APPLICABLE DOCUMENTS.

2.2 Specifications.

2.3 Standards.

2.4 Handbooks and Manuals.

2.5 Department of Defense.

2.6 Defense Logistics Services Center (DLSC).

2.7 Department of Navy.

2.8 Forms.

2.9 NON-GOVERNMENT PUBLICATIONS.

2.9.1 American National Standards Institute, Inc. (ANSI).

2.9.2 American Society for Testing and Materials (ASTM).

2.9.3 Society of Automotive Engineers Standards (SAE).

2.9.4 Institute of Electrical and Electronics Engineers (IEEE).

2.9.5 American Society of Mechanical Engineers (ASME).

2.9.6 National Institute of Standards and Technology (NIST).

3.1 REQUIREMENTS.

3.2 TECHNICAL MANUAL SCHEDULE, STATUS AND COSTS REPORTS.

3.2.1 Schedule and Status Reports.

3.2.2 Cost Reports.

3.3 TECHNICAL MANUAL QUALITY ASSURANCE DATA.

3.3.1 Validation Plan.

3.3.2 Validation Certification.

3.4 MANUAL, TECHNICAL, STANDARD.

3.4.1 Review Draft Copy (RDC).

3.4.1.1 RDC Development.

3.4.1.1.1 Arrangement.

3.4.1.1.1.1 Front Matter.

3.4.1.1.1.2 Cover and Title Page.

3.3.1.1.1.2.1.3 Prime Title.

3.3.1.1.1.2.1.4 Subtitle.

3.3.1.1.1.2.1.5 Manufacturer.

3.3.1.1.1.2.2 Contract/SEATASK Number.

3.3.1.1.1.2.3 Seal.

3.3.1.1.1.2.4 Distribution Statement. 3.3.1.1.1.2.5 Export Control Notice. 3.3.1.1.1.2.6 Destruction Notice.

3.3.1.1.1.2.7 Authority Notice.

3.3.1.1.1.2.8 Publication Date.

3.3.1.1.1.7 List of Tables.

3.3.1.1.1.8 Foreword, Preface, Introduction. 3.3.1.1.1.9 Safety Summary.

3.3.1.1.2 Style of Writing.

3.3.1.1.2.1 Support of User Tasks.

3.3.1.1.2.2 Standard English Grammar. 3.3.1.1.2.3 Grammatical Person and Mood. 3.3.1.1.2.4 First Person Pronouns.

3.3.1.1.2.5 Positive Form.

3.3.1.1.2.6 Concrete and Specific Language.

3.3.1.1.2.7 Use of "Shall", "Will", "Should" and "May". 3.3.1.1.2.8 Complex Sentences.

3.3.1.1.2.9 Sentences in Procedures.

3.3.1.1.2.10 Word Order.

3.3.1.1.2.11 List Form.

3.3.1.1.2.19 References.

3.3.1.1.2.21.4 Sentence Count.

3.3.1.1.2.24 Military Terms.

3.3.1.1.2.25 Automatic Electronic Test and Checkout Terminology. 3.3.1.1.2.26 Divisions.

3.3.1.1.2.26.1 Chapters.

3.3.1.1.2.26.2 Sections.

3.3.1.1.2.26.3 Paragraphs.

3.3.1.1.2.26.3.8.2 Procedure Length.

3.3.1.1.2.26.3.8.3 Indentations.

3.3.1.1.2.26.5 Glossaries.

3.3.1.1.2.26.6 Index.

3.3.1.1.2.27.1.2 Running Feet.

3.3.1.1.2.27.1.2.1 Page Number.

3.3.1.1.2.27.1.2.2 Issue Indicator.

3.3.1.1.2.30.1.1 General Requirements.

3.3.1.1.2.30.1.1.1 Human factors.

3.3.1.1.2.30.1.1.2 When to use Danger, Warning, or Caution statements. 3.3.1.1.2.30.1.1.2.1 Danger.

3.3.1.1.2.30.1.1.2.2 Warning.

3.3.1.1.2.30.1.1.2.3 Caution.

3.3.1.1.2.30.1.1.3 General.

3.3.1.1.2.30.1.1.4 Design criteria.

3.3.1.1.2.30.2 Health Hazards.

3.3.1.1.2.30.3 Energy Efficiency Requirements. 3.3.1.1.2.30.4 Environmental Protection.

3.3.1.1.2.31 Nuclear Hardness.

3.3.1.1.2.33.3 Line Graphs.

3.3.1.1.2.33.4 Table Cutline.

3.3.1.1.3 General Illustration Information.

3.3.1.1.3.1 Illustrations.

3.3.1.1.3.3.4 Letter Size.

3.3.1.1.3.3.5 Notes on Diagrams. 3.3.1.1.3.3.5.1 General Notes.

3.3.1.1.3.3.5.2 Specific Notes.

3.3.1.1.3.3.7.1 Retouching.

3.3.1.1.3.3.12 Multisection Illustrations.

3.3.1.1.3.3.13 Cartoons.

3.3.1.1.3.3.18 Callouts.

3.3.1.1.3.3.18.1 Index Numbers.

3.3.1.1.3.3.18.2 Nomenclature. 3.3.1.1.3.3.18.3 Leader Lines and Arrowheads. 3.3.1.1.3.3.19 Legends.

3.3.1.1.3.3.20 Steps.

3.3.1.1.3.3.21 Reference Designations. 3.3.1.1.3.3.22 Review of Illustrations.

3.3.1.2 Technical Content for HM&E Equipment Manuals.

3.3.1.2.1 Chapters.

3.3.1.2.1.1 Chapter 1, General Information and Safety Precautions. 3.3.1.2.1.1.1 Introduction.

3.3.1.2.1.1.2 Equipment Description.

3.3.1.2.1.1.3 Equipment Illustration.

3.3.1.2.1.1.4 Reference Data.

3.3.1.2.1.2.5.3 Format.

3.3.1.2.1.2.5.4 Training Summary. 3.3.1.2.1.2.5.5 Request For Number.

3.3.1.2.1.3 Chapter 3, Functional Description.

3.3.1.2.1.3.1 Functional Description.

3.3.1.2.1.4 Chapter 4, Scheduled Maintenance.

3.3.1.2.1.4.1 Introduction.

3.3.1.2.1.4.2 Scheduled Maintenance Action Index. 3.3.1.2.1.4.2.1 Schedule.

3.3.1.2.1.4.2.2 Overhaul Maintenance and Repair Standards. 3.3.1.2.1.5 Chapter 5, Troubleshooting.

3.3.1.2.1.5.1 Troubleshooting Instructions.

3.3.1.2.1.5.1.1 Diagnostic Analysis.

3.3.1.2.1.5.1.2 Troubleshooting Procedures.

3.3.1.2.1.5.1.2.1 Troubleshooting Guides.

3.3.1.2.1.5.1.2.2 Piping Diagrams.

3.3.1.2.1.5.1.8 Assemblies and Subassemblies, Modules, Standard Electronic Modules, Designated Nonrepairable.

3.3.1.2.1.6 Chapter 6, Corrective Maintenance.

3.3.1.2.1.6.1 Introduction.

3.3.1.2.1.7.1 Introduction.

3.3.1.3 Final Reproducible Copy (FRC).

3.3.1.3.1 FRC Development.

4.1 QUALITY ASSURANCE PROVISIONS.

4.2 Responsibility for Inspection.

4.3 Responsibility for Compliance.

4.3.1 Government Inspection.

4.3.1.1 Government Inspection at Subcontractor Facilities.

4.3.2 TMQA Program.

4.3.3 QA Program Organization.

4.3.4 Quality Assurance Program Functions.

4.3.4.1 Guidance and Quality Planning Conference.

4.3.4.2 Adequacy Reviews.

4.3.4.3 In-Process Reviews (IPRs).

4.3.4.3.1 IPR and Adequacy Review Location.

4.3.4.3.2 IPR and Adequacy Review Records.

4.3.4.3.3 Disposition of IPR and Adequacy Review Findings.

4.3.4.4 Quality Program Reviews.

4.3.4.5 Quality Reviews.

4.3.4.5.1 Corrective Action.

4.3.4.5.2 Data Base Control.

4.3.4.5.3 Task Identification Matrix or Equivalent.

4.3.4.5.4 Control of Subcontractors and Vendors.

4.3.4.5.5 Sampling Plans.

4.2.4.5.5.1 Validation of Readability. 4.2.4.5.5.2 Classification of Defects (CD).

4.3.4.6 Validation.

4.3.4.6.1 Validation Performance.

4.3.4.6.2 Support Equipment.

4.3.4.6.3 Disposition of Validated Data.

4.3.4.7 Verification.

4.3.4.7.1 Verification Support Requirements.

4.3.4.7.2 Combined Validation and Verification.

5.1 PACKAGING.

5.2 TECHNICAL MANUAL SCHEDULE, STATUS AND COSTS REPORTS.

5.3 QUALITY ASSURANCE PROVISIONS.

5.3.1 Validation Plan.

5.3.2 Validation Certification.

5.4 MANUAL, TECHNICAL, STANDARD.

5.4.1 Review Draft Copy (RDC).

5.4.2 Final Reproducible Copy (FRC).

8.1 PRINTING.

8.2 Authorization.

9.0 NOTES.

FIGURE LIST

NO. TITLE

4 Cover/Title Page. (Example) (Sheet 1 of 4) 5 Style, Capitalization, Leading and Vertical Spacing.

111 Major Parts of Component or Equipment.

112 Interaction of Major Parts.

113 Functional Description Diagram.

114 Equipment Inner Operation.

TECHNICAL MANUAL CONTRACT REQUIREMENT (TMCR)

DATE: 20 November 2007 TMCR NUMBER: NDMS 080027-000

REQUESTED BY: NSWC, PHILA

Commanding Officer NSWC, PHILADELPHIA 5001 S. Broad Street Philadelphia, PA 19112-1403

PREPARED BY: John J Kozul

CODE: 946

CONTRACTOR:

CONTRACT NO.: 1 5

SCOPE: This TMCR contains specific integrated requirements and instructions for the preparation of the subject standard technical manual. The requirements for the preparation of the technical content of the subject technical manual were taken from the applicable specifications and standards for technical content of manuals as specified in NAVSEAINST 4160.3A.

The requirements listed in the Contract Data Requirements List (DD Form 1423), in conjunction with the requirements of the specific contract line items as specified herein, constitute the data to be delivered, the products to be prepared, and the resulting tasks to be performed by the contractor.

1.1 DELIVERABLES.

The following deliverable items shall be prepared as specified in Section 3 of this document.

DATA ITEMS.

1.2 TECHNICAL MANUAL SCHEDULE, STATUS AND COSTS REPORTS.

1.3 QUALITY ASSURANCE PROVISIONS.

1.3.1 Validation Plan.

1.3.2 Validation Certification.

1.4 MANUAL, TECHNICAL, STANDARD.

1.4.1 Review Draft Copy (RDC).

1.4.2 Final Reproducible Copy (FRC).

1.3.2.1 Final Digital Encoding of Technical Publications.

2.1 APPLICABLE DOCUMENTS.

2.2 Specifications.

The following documents were used to establish the requirements of this document.

MIL-DTL-24784B(SH) Manuals, Technical: General Acquisition and Development Requirements

MIL-DTL-24784/12B(SH) Associated Detail Specification Hull, Mechanical, and Electrical (HM&E) Equipment and Single Component Manual Requirements

MIL-PRF-28001C Markup Requirements and Generic Style Specification for Exchange of Text and its Presentation.

MIL-PRF-28002C Raster Graphics Representation in Binary Format, Requirements for.

MIL-STD-38784 Standard Practice for Manuals, Appendix C Document Technical: General Style and Type Definition (DTD) Format Requirements

MIL-PRF-49506 Logistics Management Information

2.3 Standards.

MIL-STD-17B-1 Mechanical Symbols

MIL-STD-1309 Definition of Terms for Test, Measurement, and Diagnostic Equipment

MIL-STD-1840C Military Standard Automated Interchange of Technical Information

DOD-STD-1686 Electrostatic Discharge Control Program for Protection of Electrical and Electronic Parts, Assemblies and Equipment (Excluding Electrically Initiated Explosive Devices)

(Copies of standards required by contractors in connection with specific procurement functions should be obtained from the procuring activity or as directed by the contracting officer.)

2.4 Handbooks and Manuals.

Government Printing Office.

United States Government Style Manual Printing Office

2.5 Department of Defense.

JCS Pub 1 DOD Dictionary of Military and Associated Terms

Application for copies should be addressed to:

The Superintendent of Documents, U.S. Government Printing Office, Washington, DC 20402

2.6 Defense Logistics Services Center (DLSC).

H4/H8 Commercial and Government Entity (CAGE) Codes

Application for copies should be addressed to: Defense Logistics Services Center, (ATTN: DLSC-SBB), Federal Center, Battle Creek, MI 49107-3084

2.7 Department of Navy.

SE000-01-IMB-010 Navy Installation and Maintenance Book

Application for copies should be addressed to:

The Standardization Documents Order Desk, Building 4D, 700 Robbins Avenue, Philadelphia, PA 19111-5094

2.8 Forms.

Form NAVSEA 4160/1 NAVSEA (User) Technical Manual Deficiency/Evaluation Report (TMDER)

Form NAVSEA 4160/3 Technical Manual Validation Certificate

Copies of forms required by the preparing activity in connection with specific procurement functions should be obtained from:

The Standardization Documents Order Desk, Building 4D, 700 Robbins Avenue, Philadelphia, PA 19111-5094

2.9 NON-GOVERNMENT PUBLICATIONS.

The following document(s) form a part of this document to the extent specified herein. Unless otherwise specified, the issues of the documents which are DOD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation.

Aerospace Industries Recommendation for Hazardous Association, AIA-TR91-1 Materials Warnings in Technical Publications DOD Liaison Data

(Application for copies should be addressed to the Aerospace Industries Association, 1250 Eye Street NW, Washington, DC 20005.)

2.9.1 American National Standards Institute, Inc. (ANSI).

The following standards shall apply:

ANSI X3.5 Flow Chart Symbols and Their Usage in Information Processing

ANSI Y32.10 Graphic Symbols for Fluid Power Diagrams

ANSI Y14.5 Dimensioning and Tolerancing

ANSI Z535.3 Criteria for Safety Symbols

Application for copies should be addressed to:

American National Standards Institute, Inc.

25 West 43rd Street New York, N.Y. 10036 or http://www.ansi.org

2.9.2 American Society for Testing and Materials (ASTM).

ASTM D3951 Standard Practice for Commercial Packaging

Application for copies should be addressed to:

American Society for Testing and Materials, 100 Barr Harbor Dr., West Conshohocken, PA 19428-2959 or http://www.astm.org

2.9.3 Society of Automotive Engineers Standards (SAE).

SAE AS1290 Hydraulic System Diagrams and Associated Tables for Marine Vehicles

Application for copies should be addressed to:

SAE World Headquarters, 400 Commonwealth Drive, Warrendale, PA 15096-0001 or http://www.sae.org

2.9.4 Institute of Electrical and Electronics Engineers (IEEE).

IEEE 945-84 IEEE Recommended Practice for Preferred Metric Units for Use in Electrical and Electronics Science and Technology

Application for copies should be addressed to:

The Institute of Electrical and Electronics Engineers, Inc., 445 Hoes Lane, Piscataway, N.J. 08855-1331 or http://www.ieee.org

2.9.5 American Society of Mechanical Engineers (ASME).

The following standards shall apply:

Application for copies should be addressed to: American Society of Mechanical Engineers, Three Park Avenue, New York, NY 10017 or http://www.asme.org

2.9.6 National Institute of Standards and Technology (NIST).

NIST Special Publication 811 Guide for the Use of the International System of Units (SI).

Application for copies should be addressed to:

NIST

100 Bureau Drive, Stop 1070 Gaithersburg, MD 20899-1070

3.1 REQUIREMENTS.

In the event of a conflict between the text of this document and the references cited herein, the text of this document takes precedence. Nothing in this specification, however, supersedes applicable laws and regulations unless a specific exemption has been obtained.

Advertising. Technical manuals shall contain no advertising unless the contract or SEATASK specifies that the equipment manufacturer shall be identified on the cover.

Copyrights and proprietary information credit line. Technical manuals shall not contain copyrighted material except as specified in the Federal Acquisition Regulations and Defense Federal Acquisition Regulation Supplement. When copyrighted material is to be included in a technical publication, the developer shall obtain prior written permission from the copyright owner or authorized agent for its use. The signed, written permission shall be delivered together with the final reproducible copy. The written permission shall contain a statement declaring whether or not a copyright credit line is required. When it is necessary to include copyright and proprietary material, it shall be clearly identified and the following warning statement shall be included on the title page:

"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."

Security classification, distribution statement and destruction notice. Security classification, distribution statement and destruction notice shall be in accordance with this document. The overall security classification assigned to a technical manual shall agree with the highest classification assigned to any portion within. The security markings shall be the same as for other title pages. For destruction notice see 3.3.1.1.1.2.6.

Source Data. The primary source data for technical manuals shall be engineering drawings and, if a requirement, Logistic Support Analysis (LSA) and Logistic Support Analysis Record (LSAR).

Maintenance coverage. Organizational, intermediate, and depot maintenance levels shall be covered in a combined single manual.

Distribution Statement. Each technical manual and modification thereto shall be marked, in accordance with DODD 5230.24, to denote its availability for distribution, release, and disclosure without additional approvals and authorizations (see 3.3.1.1.1.2.4). This marking shall be in addition to a security classification marking. Additionally, a determination shall be made in accordance with DODD 5230.25 whether the technical manual contains export controlled technical data.

3.2 TECHNICAL MANUAL SCHEDULE, STATUS AND COSTS REPORTS.

3.2.1 Schedule and Status Reports.

A technical manual schedule and status report shall be supplied at the frequency determined by the contract or SEATASK. The report shall be in a narrative format and indicate the information necessary to provide a comprehensive management level analysis of all development activities.

3.2.2 Cost Reports.

Technical manuals shall be acquired in a cost-effective manner. Cost and pricing data shall be obtained for each new, revised or changed manual. A separate analysis shall be provided together with supporting documentation for each manual developed. The cost of technical manuals shall be limited to the effort and material needed to produce the manual from source data.

3.2 TECHNICAL MANUAL QUALITY ASSURANCE DATA.

3.2.1 Validation Plan.

A validation plan shall be developed and shall be acceptable to the government. It shall reflect compatibility with the overall maintenance and support plan, outline the preparing activity`s recommended validation procedure, and indicate the scope of the validation effort. It shall also include manuals for which requirements have yet to be defined, such as equipment component and support equipment manuals. The plan shall reflect the requirements of this document. The plan shall include recommendations for simultaneous validation or verification as appropriate. The validation plan shall ensure there is a system for inspection, validation, and correction of the manual. Validation shall provide a measure of the overall quality of the manual. When the Government performs an inspection at a preparing activity`s plant, such inspection shall not be used by the preparing activity as evidence of effective control of quality. When revisions or corrections are required after any inspection, validation, or review, there shall be reinspection, revalidation, or re-review by the preparing activity, and if necessary, by the Government of all data affected. The validation plan shall include:

a. Validation by which the technical manual is tested for technical adequacy and accuracy and compliance with the provisions of this document and other technical contractual requirements.

b. Detailed review of FRC to ensure that this material is identical to the authorized, validated, verified, corrected, and accepted draft or preliminary manuals and complies with legibility and reproducibility requirements.

3.2.2 Validation Certification.

The preparing activity shall prepare a validation certification attesting to the technical manual adequacy and accuracy by actual performance or simulation. Individual validation certification reports shall be prepared for each technical manual validation by the preparing activity, using NAVSEA Form 4160/3 from S0005-AA-PRO-010/TMMP as the certification document.

3.3 MANUAL, TECHNICAL, STANDARD.

3.3.1 Review Draft Copy (RDC).

RDCs shall be developed for review and coordination for technical accuracy and adequacy to evaluate the preparing activity`s progress and assess compliance with this document and terms of the contract or SEATASK. RDCs shall be submitted for acceptance prior to development of the PTM or FRC.

3.3.1.1 RDC Development.

The RDC shall be developed as follows:

a. RDC shall be formulated in accordance with the approved outline and represent the configuration of the hardware.

b. The text shall be computer generated, double spaced, on one side of the paper and shall contain the exact wording and content intended for the reproducible copy. The RDC may be issued initially in single column format and may include voids where information is not available. The production method may be the most economical method at the option of the preparing activity. When the RDC is presented in computer or other form such that the paragraphing or symbols cannot be readily understood, it shall be annotated to make the paragraphing and symbols clear to the reviewer.

c. All front matter, text, tables, and illustrations shall meet the content, format, page size and image area requirements of this document.

d. The binding edge shall not be less than 1 inch and the outside edge not less than 1/4 inch. The method of duplication, covering and binding shall provide legible, collated copies.

e. Unclassified RDCs shall be duplicated and loose leaf bound in pressboard or equivalent binders.

f. Reproduction of penciled illustrations are acceptable if their technical content, clarity, correctness, and adequacy meet requirements of this document. Illustrations submitted for review shall be legible.

g. Illustrations, drawings, and tables shall be final size, complete with titles, figures, and table numbers.

h. Official nomenclature, common names, and equipment abbreviations shall appear in their normal-reading sequence. The nomenclature shall be used consistently in the text, figures, and tables of the text plan. Transposed nomenclature shall be used in illustrated parts breakdowns (IPBs) or indices.

i. The words "REVIEW DRAFT COPY" shall be placed on the cover and title page above the technical manual identification number.

j. The RDC shall be complete in all respects with all in-process review comments incorporated. A completed and signed validation certificate shall accompany the RDC submitted for technical review. Following review, the developing activity shall incorporate all required changes.

k. Shading or color-coding is not required in the RDC but functional boundaries shall be illustrated by dotted lines. Hardware boundaries shall be indicated by dot-dash lines, with the number of dots corresponding to the level of containment (first level, second level, and so forth).

l. The RDC shall be proofread, technically edited, validated in accordance with the validation plan, and collated in the same manner as the final manual prior to submittal.

3.3.1.1.1 Arrangement.

Each manual shall be arranged according to a standardized format (as applicable):

a. Front matter.

b. Technical content subject matter.

c. Appendices.

d. Glossaries.

e. Indices.

f. Technical Manual Deficiency/Evaluation Reports (TMDERs).

3.3.1.1.1.1 Front Matter.

Front matter pages, except change record pages, following the list of effective pages and preceding chapter 1 shall be assigned sequential lower case Roman numerals, i.e., i, ii, iii, etc. Material preceding the first chapter shall consist of the following in the order specified:

Cover/Title Page List of Effective Pages Change Record Table of Contents List of Illustrations List of Tables Foreword/Preface/Introduction Safety Summary (as applicable)

3.3.1.1.1.2 Cover and Title Page.

Manuals shall have either a cover or title page, or an abbreviated title. There shall be a cover and title page. The cover/title page shall contain the information indicated by Figure 4. Figure 4 also lists the requirements for abbreviated titles. Abbreviated titles shall be used only when specified. If there is both a cover and title page, the date shall be omitted from the cover page. A manual shall require a backbone for binder or cover. FRC for the backbone or cover of a manual shall be in accordance with Figure 9. The TM identification number will be furnished by the acquiring activity. Certain information such as the supersedure notice, supplement notice, disclosure notice and destruction notice, as applicable, may be placed on the reverse side of the title page if additional space is needed to avoid overcrowding of the title page (that is, small technical manuals such as job guides and work cards). The reverse side of the title page, when used as a continuation of the title page, shall be numbered. Title pages shall be unnumbered; however, the first page of a brief manual that uses an abbreviated title, below which the beginning text is placed, shall be assigned Arabic numeral 1.

3.3.1.1.1.2.1 Title.

The TM title shall consist of the following, located as shown in Figure 4.

a. WARNING (if the manual contains unverified data).

b. Heading "TECHNICAL MANUAL"

c. Type of Manual

d. Maintenance Level (if restrictive)

e. Prime title (type and model)

f. Subtitle (as applicable)

g. Manufacturer

3.3.1.1.1.2.1.1 Type of Manual.

The type of manual shall be placed beneath the "TECHNICAL MANUAL" heading.

3.3.1.1.1.2.1.2 Maintenance Level(s).

The level(s) of maintenance, as appropriate, shall be placed beneath the manual type. When only one maintenance manual is being acquired to support a weapon, equipment or hardware, no level shall be specified unless restrictive, since it will be the only manual available for repair and maintenance at any designated maintenance level (Organizational, Intermediate or Depot).

3.3.1.1.1.2.1.3 Prime Title.

The nomenclature of the equipment, type, model, part number or subject (blocks, serial numbers or registration numbers, if appropriate) shall be positioned below the words identifying the manual type or maintenance level, if applicable. When specified, the national stock number and identification of other equipment covered in the manual shall be indicated.

3.3.1.1.1.2.1.4 Subtitle.

A subtitle shall be used and located immediately below the prime title to indicate the contents of every separately bound volume and part of a Technical Manual.

3.3.1.1.1.2.1.5 Manufacturer.

The identification of the manufacturer of the equipment shall appear below the equipment nomenclature or subtitle, as applicable.

3.3.1.1.1.2.2 Contract/SEATASK Number.

The original contract/SEATASK number shall be placed on all new issues and carried forward on all subsequent cover and title pages. If the contract/SEATASK number for a change or revision is different from the original number, the number applicable to the change or revision shall be indicated on the cover and title page in addition to the original number. No more than two contract/SEATASK numbers, the original and the latest, need appear.

3.3.1.1.1.2.3 Seal.

The Department of the Navy Seal, with command identifier, is placed below the Contract/SEATASK number(s).

3.3.1.1.1.2.4 Distribution Statement.

All TMs shall have a distribution statement placed on the cover and title page. The appropriate distribution statement, will be provided by the Government. Unless otherwise specified, Distribution Statement C shall be placed on the cover and title page

3.3.1.1.1.2.5 Export Control Notice.

When required, an Export Control Notice shall be placed on the cover and title page of each manual, manual supplement, revision or change:

"WARNING: This document contains technical data whose export is restricted by the Arms Export Control Act (Title 22, U.S.C. SEC 2751, et seq) or the Export Administration Act of 1979, as amended, Title 50, U.S.C., App 2401 et seq. Violations of these export laws are subject to severe criminal penalties. Disseminate in accordance with provisions of DOD Directive 5230.25(D)."

3.3.1.1.1.2.6 Destruction Notice.

All technical documents marked with distribution statements A, B, C, D, E, F or X shall be marked with the destruction notice from DOD 5230.24 on the cover and title page as follows:

"Destruction Notice: Destroy by any method that will prevent disclosure of contents or reconstruction of the document."

3.3.1.1.1.2.7 Authority Notice.

The authority notice will be provided by the Government. Manuals to be jointly used shall show a joint authority notice.

3.3.1.1.1.2.8 Publication Date.

The publication date of the manual shall be the cutoff date from which no further changes to the manual are permitted without issuing a formal change. This is normally the "approved date", that is, the date the government accepts the manual subject to the inclusion of specified comments. If the acquiring activity does not advise the preparing activity the exact date to use, the publication date shall be the date at which the last material to be included was received (copy freeze date).

The day, month, and year shall be given in that sequence.

3.3.1.1.1.3 List of Effective Pages.

A List of Effective Pages shall be prepared in accordance with Figure 1124. The list of effective pages shall back up the title page and be numbered using the letter "A" in the lower left-hand corner. When the list of effective pages begins as a right hand page, the letter "A" shall be in the lower right-hand corner. When additional pages are required, they shall be identified as "B", "C", etc. When the last page is a right hand page, it shall not be backed up and will list the next succeeding page as blank, e.g. "B/(C blank)". The list of effective pages shall be a complete list of all manual pages, including title page, the list of effective pages, table of contents pages, safety summary pages, blank pages, deleted pages, added pages and foldout pages. The list of effective pages shall include a statement of the total number of pages in the manual. The list of effective pages shall be updated for each change or revision. The listing shall be held to a minimum by grouping numbers where applicable. The page numbers for a blank page and the printed side of the sheet shall be listed as separate numbers even though a double number will appear on the printed side of the sheet. Appropriate change numbers shall be placed in the "Change No."column. The words "Deleted" or "Blank" shall be placed alongside the page number of pages so affected.

3.3.1.1.1.3.1 Acquiring Service Identification.

The abbreviation of the acquiring Service, for example, USN, shall be placed in the lower right corner of the list of effective pages (page "A" only). If a Service acquires a manual for exclusive use of another Service, the symbol in the lower right-hand corner of the page shall still show the abbreviation of the acquiring Service.

3.3.1.1.1.4 Change Record.

Unless otherwise specified, a change record, when included, shall be prepared in accordance with Figure 21. The change record should not back or be backed up. These pages shall not be numbered.

3.3.1.1.1.5 Table of Contents.

A table of contents listing parts, chapters, sections and paragraphs in the same order and with the exact titles used in the text, with page number, shall be placed at the beginning of each publication (see Figure 11). In publications containing alphabetical indexes (see 3.3.1.1.2.26.6), only primary and first subordinate paragraphs shall be listed in the table of contents. There shall be no table of contents preceding individual chapters or sections. Layout shall conform to Figure 11 except that a single column format shall be used when the manual is prepared in single column.

3.3.1.1.1.5.1 Table of Contents for Review Draft Copy.

The page number column for tables of contents may be left blank when working on RDC during the early stages of preparation. The page number column may be filled, if the composition equipment can produce the table of contents automatically.

3.3.1.1.1.6 List of Illustrations.

Publications containing ten or more illustrations (including charts and graphs assigned figure numbers) shall have a list of illustrations showing the figure number, title, and page number of each figure. This list shall include foldout pages, schematics, and so forth. The security classification, if any, of illustration titles shall be indicated. Layout shall conform to Figure 1131 except that a single column format shall be used when the manual is prepared in single column.

3.3.1.1.1.7 List of Tables.

Manuals containing ten or more tables (including charts assigned table numbers) shall have a list of tables showing the table number, title, and page number of each table. The security classification, if any, of table titles shall be indicated. Layout shall conform to Figure 1132 except that a single column format shall be used when the manual is prepared in single column. When both are brief, the list of illustrations and list of tables may be included on the same page.

3.3.1.1.1.8 Foreword, Preface, Introduction.

A foreword, preface or introduction (see figure 1128) shall contain the purpose and scope of the manual plus any other information required by this document. The foreword, preface or introduction shall define abbreviations and nonstandard symbols, including any icons used in the manual if not explained elsewhere. The manual shall provide current information on contacting distance support (anchor desk) via the web (https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=anchordesk) and via the toll free number (1-877-4-1-TOUCH [86824]). The following statement shall also be included:

"Ships, training activities, supply points, depots, Naval Shipyards and Supervisors of Shipbuilding are requested to arrange for the maximum practical use and evaluation of NAVSEA technical manuals (TMs). All errors, omissions, discrepancies, and suggestions for improvement to NAVSEA TMs shall be submitted as a Technical Manual Deficiency/Evaluation Report (TMDER). All feedback comments shall be thoroughly investigated and originators will be advised of action resulting there from.

(Use this statement for printed hard copy TMs) Three copies of the NAVSEA/SPAWAR Technical Manual Deficiency/Evaluation Report form, NAVSEA 4160/1 are included at the end of each separately bound hardcopy TM.

(Use this statement for a TM on CD-ROM) The NAVSEA/SPAWAR Technical Manual Deficiency/Evaluation Report form, NAVSEA 4160/1 is included as the last page of the TM.

(Include this statement for all TMs) Copies of form NAVSEA 4160/1 may also be downloaded from: https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=tmderblank2-s

The following methods are available for generation and submission of TMDERs:

- The most expedient and preferred method of TMDER generation and submission is via the Technical Data Management Information System (TDMIS) website at:

https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=tdmisweb TDMIS accounts can be requested at: https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=nsdsaweb

· Generate and submit TMDER via the Naval Systems Data Support Activity (NSDSA) website at: https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=tmderform

· When internet access is not available, submit TMDER via hardcopy to:

COMMANDER

CODE 310 TMDERs NAVSURFWARCENDIV NSDSA

4363 MISSILE WAY, BLDG 1388 PORT HUENEME, CA 93043-4307

· TMDERs against classified TMs must be submitted using the hardcopy method cited above.

· Urgent priority TM deficiencies shall be reported by Naval message with transmission to Port Hueneme Division, Naval Surface Warfare Center (Code 310), Port Hueneme, CA.

Local message handling procedures shall be used. The message shall identify each TM deficiency by TM identification number and title. This method shall be used in those instances where a TM deficiency constitutes an urgent problem, (i.e., involves a condition, which if not corrected, could result in injury to personnel, damage to the equipment or, jeopardy to the safety or success of the mission).

Complete instructions for TMDER generation and submission are detailed on the NSDSA website at: https://nsdsa2.phdnswc.navy.mil/smarttredirect?urlkey=tmder24-s

3.3.1.1.1.9 Safety Summary.

The safety summary shall be located as the last page(s) of the front matter. Figure 1129 is an example of the content and format of safety summaries.

3.3.1.1.2 Style of Writing.

Writing style shall be in accordance with GPO Style Manual. Style of writing shall ensure:

a. Technical content shall be presented in language free of vague and ambiguous terms, using the simplest words and phrases which will convey the intended meaning. GPO Style Manual shall be used as a general guide for capitalization, punctuation, compounding of words, numerals in the text and spelling of nontechnical words. All essential information shall be included, either by direct statements or by reference. Sentences shall be short and concise. Punctuation shall be used in a manner which aids in reading and prevents misreading. Sentences shall be rewritten when extensive punctuation is necessary for clarity. Technical words shall be used only when no other wording will convey the intended meaning.

b. For maximum clarity and usefulness, there shall be consistency in terminology and organization within the same publication or series of publications. Nomenclature shall be consistent within a publication and throughout parts lists, parts breakdowns and other directly related publications.

c. Quotation marks and underscoring shall not be used for emphasis.

d. Words which have more than one meaning which will fit the context in which they are used, such as "replace" for "reinstall," shall not be used.

e. Chapter, section and paragraph headings shall be descriptive of the contents of the division they head; "General" and "Miscellaneous" shall not be used unless no other title will suffice.

f. Statements which explain applicability for individual items of equipment shall use specific serial number(s), block designation(s), specific model designation(s) or similar identification. Such terms as "on later equipment" and "on early serial numbers" shall not be used.

g. Technical publications shall make no reference to age, sex, race or national origin. Use sex neutral terms, except avoid use of the word "person" (terms such as "midshipman" and "workman" are considered sex neutral). Terms such as male and female connectors, pins, and so forth, are acceptable.

3.3.1.1.2.1 Support of User Tasks.

To the extent possible, information shall be presented that:

a. Directly supports the immediate task of the user.

b. Minimizes need for reading, studying, and conceptualizing skills.

c. Minimizes need to refer to other documents or text material.

3.3.1.1.2.2 Standard English Grammar.

Rules of grammar for standard American English shall be used. Colloquial, substandard, and slang expressions shall not be used. Infinitives may be split and sentences may be ended with prepositions in cases where not doing so sounds awkward or stilted and is likely to distract the user's attention from comprehending the content.

3.3.1.1.2.3 Grammatical Person and Mood.

The second person imperative mood shall be used for procedures, i.e., "Remove test set from carrying case." Third person indicative mood shall be used for description and discussion.

3.3.1.1.2.4 First Person Pronouns.

First person pronouns should be used, to avoid indefinite passive construction.

3.3.1.1.2.5 Positive Form.

Procedural steps shall be in positive form ("Close the container" rather than "Do not leave the container open") unless the meaning demands the negative form.

3.3.1.1.2.6 Concrete and Specific Language.

Concrete and specific language shall be used to reduce vagueness.

3.3.1.1.2.7 Use of "Shall", "Will", "Should" and "May".

Use "shall" whenever a manual expresses a provision that is binding. Use "should" and "may" whenever it is necessary to express nonmandatory provisions. "Will" may be used to express a declaration of purpose. It may be necessary to use "will" in cases where simple futurity is required.

3.3.1.1.2.8 Complex Sentences.

If a sentence has more than one clause and is more than 20 words in length, it shall whenever possible be rewritten as two or more simple sentences.

3.3.1.1.2.9 Sentences in Procedures.

Sentences directing the actions of the user shall be in the active voice and imperative mode. If more than one person is involved, the directions shall be in the active voice, indicative mode, third person.

3.3.1.1.2.10 Word Order.

Sentences and clauses shall be written using simple word order (subject, verb, object) to the extent possible. Modifiers, including prepositional phrases, shall be as close as possible to the word modified. These word order requirements shall be relaxed only to the extent necessary to avoid ambiguity or distortion of meaning. Procedural steps shall start with an active verb; lubricate, remove, tighten, and so forth.

3.3.1.1.2.11 List Form.

If any series of three items or more appears in a sentence, the sentence shall be written so the items will appear in explicit list.

3.3.1.1.2.12 Simple versus Complex Phrases.

Complicated phrases shall be avoided.

3.3.1.1.2.13 Synonyms.

Use of synonyms to provide variety in technical writing can lead to confusion. If there are several synonyms for a concept or object, only one shall be selected and used consistently throughout the technical manual.

3.3.1.1.2.14 Shortened Equipment Names.

In each section supporting a single user task, official terminology shall be used for the first reference to a hardware item. Official terminology shall be used wherever the use of a shortened name might be ambiguous.

3.3.1.1.2.15 Nomenclature.

Nomenclature associated with systems, equipment, and components shall be introduced by means of illustrations coordinated with descriptive text.

3.3.1.1.2.16 Consolidation of Material.

To the extent possible, all information required to complete a single task shall be put in one location in the manual. Information and artwork shall be repeated as necessary to fulfill this requirement. The need for the user to refer to other parts of the manual or to other information sources during performance of a task shall be minimized.

3.3.1.1.2.17 Organization of the Technical Manual.

To ensure comprehensibility (the completeness with which a user in the target audience understands the text or text-graphics combination), technical manuals shall be organized on the basis of the user's need for information.