Attachment_4_AIS-2_TMCR.pdf

ATTACHMENT 4

TECHNICAL MANUAL CONTRACT REQUIREMENTS (TMCR)

SOLICITATION: 70Z04418R18002300

TECHNICAL MANUALS

1. Performance Requirements

1.1. General. The Contractor shall provide to the Government all technical data, and certain rights to that data, necessary to operate, maintain, diagnose, and perform operator level repairs to AIS-2 throughout its lifecycle. Technical manuals shall be delivered in the form of Commercial Off-The Shelf (COTS)

Manuals, Supplemental Data or Contractor Developed Manuals.

1.2. Planning. The Contractor shall deliver a Technical Data Index (TDI) which identifies all Technical

Manuals (TM) expected to be developed under this contract in accordance with CDRL A001.

1.2.1. Upon receipt of the draft TDI, the Government will assign a Ship Work Breakdown Structure

(SWBS) designation and a unique number TM Number that will be used by the Contractor to identify each TM in the final TDI.

1.3. Data Rights. The contractor shall deliver the rights to the electronic source material used to develop the COTS technical manuals, thereby simplifying efforts in developing the required derivative works.

Special emphasis shall be placed on obtaining and documenting Government rights to the technical data, and appropriately marking the data so the nature of the rights are clearly identified, particularly when Government rights differ from the rights available to the general public.

1.3.1. For technical data not first developed in the performance of this contract for which a copyright is claimed in accordance with 17 U.S.C. 401 or 402, specifically including COTS manuals, the contractor shall provide on the Government's behalf a paid-up, nonexclusive, irrevocable worldwide license in such copyrighted data for the use of the Government to reproduce, prepare derivative works, by or on behalf of the Government. See FAR 52.227- 14(c)(2). The contractor shall include a data rights release letter on OEM letterhead placed directly before the table of contents. This letter shall not back or back up any page.

1.3.2. For restricted computer software, specifically including software and firmware contained in equipment provided in AIS-2 (e.g., transponder firmware), as well as any additional software used to update or maintain that software or firmware (e.g., diagnostics and/or programming software for data bus, sensors, etc.), the Contractor shall acquire on the Government's behalf a paid-up nonexclusive, irrevocable worldwide license in such computer software to use and disclose to support service Contractors and their subcontractors in accordance with FAR 52.227-14 (g)(3)

(Alternate III) and FAR 52.227-19(c).

1.3.3. Restrictive markings like confidential, secret, classified, etc. that could be confused with official

Government classifications shall be removed from all manuals prior to being submitted to the

Government.

1.4. Types and Format. The Contractor will acquire or develop Technical Manuals that meet the content requirements defined in the sections below. The will be delivered to the Government in unlocked and editable PDF format. All delivered PDF documents shall allow a user to select and copy text within them. The three types of technical manuals are defined as:

1.4.1. COTS Manuals: Commercial Off-the Shelf (COTS) Manuals are defined as vendor/Original

Equipment Manufacturer (OEM) manuals. They will be evaluated to meet the requirements defined in MIL-PRF-32216A developed in accordance with MIL-DTL-24784/4C (CDRL A002).

1.4.1.1. Source data will be provided for these manuals by the contractor when available. Source data is defined as the editable format, such as Word or XML, in which the manuals were developed. If the source data is not available then the required format is unlocked PDF.

1.4.1.2. Supplemental Data: When COTS manuals do not contain sufficient detail to meet the requirements of MIL-PRF-32216A, the contractor will develop and provide supplemental data.

Supplemental data content will be prepared in accordance with MIL-PRF-32216A and formatted in accordance with MIL-STD-38784A. Supplemental data will be placed at the end of the associated COTS Manual as appendices.

1.4.2. Contractor Developed Manuals: These are manuals that will be developed by the contractor when OEM/COTS manuals are not available and when specifically called out in the contract. They should be formatted in accordance with MIL-STD-38784A.

1.4.3. AIS-2 System Operators Manual (SOM): A SOM shall be prepared in accordance with CDRL

A003. It shall provide a complete description of the AIS-2’s capacities and characteristics and shall contain operating instructions for all systems, equipment, and components in the AIS-2. This includes system descriptions, operating principles, system level alignment, operating modes and maintenance not covered in equipment level COTS manuals or elsewhere in the SOM. The information shall be given in sufficient detail to permit following out the systems and circuits of control. System diagrammatics shall be included to supplement the written description. System working drawings may be used in lieu of the diagrammatics upon approval of the Contracting

Officer. The SOM shall:

1.4.3.1. Describe the AIS-2 system as a key component within an integrated suite and provide a source of technical information relative to the system arrangements. All delivered PDF documents shall allow a user to select and copy text within them.

1.4.3.2. Provide system-level operating instructions for normal and abnormal operating modes including start-up, transfer of control, failure detection and identification (both automatic and manual).

1.4.3.3. Provide, where applicable, system-level information regarding redundancy, access control, data security, and procedures for data backup, restoration of system functions and software reload.

1.4.3.4. Appropriately note the following references, when applicable, in the text:

1.4.3.4.1. Reference to title and drawing numbers of onboard plans.

1.4.3.4.2. Reference to drawings, drawing indexes, drawing booklets, lists, schedules and publications by their title and number when such documents are easily recognized by such designation

1.4.3.4.3. Booklet of Test Memoranda

1.4.3.4.4. Reference to technical publications by title and Coast Guard number.

2. Content

2.1. The Contractor shall deliver content for AIS-2 installed equipment, support equipment, and training equipment. Content shall include information necessary for the operation, maintenance, service, and repair of AIS-2 (including illustrated parts breakdowns), to include each CI in the CSA and any contractor-developed components they comprise. This technical data shall include, at a minimum, pictorial or photographic display of the subject matter and should include animations or video whenever possible to maximize the training effectiveness to the intended operational audience and enhance end user learning. All videos shall be delivered in (WMD) file format or Windows Media Player compatible format.

2.1.1. Class Applicability. Content shall reflect the configuration of the fleet by vessel class, specifically to include the ability to identify eventual differences in configuration within vessel classes. For each item on the Master Equipment List (MEL), the Contractor shall deliver the following content as described in this Section.

2.1.2. The Contractor shall provide commercial equipment manuals, primary vendor drawings, service parts lists, and supplemental data for each Configuration Item. Where commercial information covers more than one model or variant, that information which is applicable to the installed equipment shall be clearly indicated and modified as necessary to completely and accurately reflect specific equipment used in AIS-2. The information shall include:

2.1.2.1. Assembly and disassembly instructions with comprehensive illustrations showing each step. Sequential instructions for disassembling, repairing, replacing, and reassembling the equipment shall be provided. Test, adjustment, and check-out data after reassembly shall be provided. Illustrations, including exploded views, shall be used as necessary to support each of these functions.

2.1.2.2. Recommended planned maintenance

Maintenance data shall incorporate the Reliability, Maintainability and Availability (RMA) analysis.

2.1.2.3. Performance Verification

Instructions for calibration of the test, measurement, and diagnostic equipment needed to restore the equipment to serviceable accuracy (performance verification) shall be provided. These instructions shall be complete step-by-step procedures which will enable the user to check the accuracy of the indications or readings. The location of test connections and the values expected at these points shall be included. Adjustment of built-in self test features shall be included when applicable. Data shall include the recommended frequency of adjustments and verification checks required. When appropriate, the data shall allow for the accomplishment of these adjustments by utilizing a wiring harness, test points, etc., that are accessible from outside the equipment case. Data shall include a list of the additional equipment, such as temperature, vacuum, pressure, hydraulic or pneumatic gauges, decade boxes, voltmeters, signal generators, required to accomplish the verification. The listing shall show methods of use or application, range of scales, and specific minimum tolerances or percentages of accuracy.

2.1.2.4. Inspection

Instructions, including scheduling, for inspection of equipment for damage and wear shall be provided with emphasis on allowable service limits such as wear, backlash, end play, balance, and length and depth of scoring. Allowable service limits are acceptable wear tolerances which will not impair performance. They are not to be confused with manufacturing tolerances.

2.1.2.5. Complete troubleshooting procedures

Malfunctions that might occur during operation of the equipment shall be identified.

Troubleshooting data, and fault isolation techniques shall include:

a. The indication or symptom of trouble.

b. The instructions necessary, including test hookups, to determine the cause.

c. Action or reference to action to restore the equipment to operating conditions.

Applicable information shall be in chart form, logic tree form, in tabular format with appropriate headings, or as logic, block, or schematic diagrams. The established maintenance concept for the associated equipment shall dictate the depth of the troubleshooting such as, localizing a defective circuit card assembly and ending the action by removing and replacing the circuit card assembly as contrasted with the carrying out the troubleshooting process on the defective circuit card assembly to determine the specific piece part that is defective.

2.1.2.6. Reprogramming

A description of reprogrammable memory, reprogramming theory, program setup, program confidence check-out, program loading, and programming procedures shall be provided for equipment having a reprogrammable memory.

2.1.2.7. Preparation for Shipment

Manuals shall contain instructions for the following, as applicable.

2.1.2.7.1. Disassembly, removal, and separate packaging of electrostatic sensitive discharge devices or fragile components.

2.1.2.7.2. Use of reusable shipping cases or containers.

2.1.2.7.3. Special cradles.

2.1.2.7.4. Mounting.

2.1.2.7.5. Securing.

2.1.2.7.6. Covering and preservation.

2.1.2.7.7. Precautions for shipment.

2.1.2.7.8. Shipment and unloading.

2.1.2.8. Storage

Manuals shall contain instructions for the following:

2.1.2.8.1. Indoor and outdoor storage.

2.1.2.8.2. Temperature and other environmental limitations.

2.1.2.8.3. Storage facilities.

2.1.2.8.4. Dunnage.

2.1.2.8.5. Ventilation.

2.1.2.8.6. Revetting.

2.1.2.8.7. Drainage.

2.1.2.8.8. Staking.

2.1.2.8.9. Grounding.

2.1.2.8.10. Covering.

2.1.2.8.11. Preservation.

2.1.2.9. Basic characteristics

Information regarding equipment model(s), dimensions, weight, volume, center of gravity, along with power, utility and environmental information.

2.1.2.10. Installation criteria and drawings

Special installation instructions shall include requirements for foundations, ventilation, clearances, plumbing and electrical connections, mountings, wiring runs, initial lubrication, and alignment as applicable. The contractor shall deliver technical data in sufficient detail to fully document the performance of all actions required for the removal and installation of all

Configuration Items (CI) for which the Government requests maintenance be developed.

2.1.2.11. Parts lists

The manual shall include a parts list containing positive identification of parts for support of the equipment and shall include actual manufacturer or vendor part numbers or generic description necessary to obtain replacement parts.

2.1.2.11.1. Parts list Illustrations

Clear and legible illustrations shall identify component parts and parts relationships.

2.1.2.11.2. Parts Listing

Part numbers and part names shall be shown on illustrations or separately listed. When the illustrations do not contain part numbers and part names, both the illustrations and separate listings shall show either index, reference, or key numbers which will cross-reference illustrated parts to listed parts. The parts list shall cite the actual manufacturer or vendor and their part number or generic description. Parts in the listings shall be grouped by assemblies, subassemblies, and modules with the parts identified to the assembly from which they are components.

2.1.2.11.3. Common Commercial Parts

Common commercial hardware and items that are not of special design, such as bolts, washers, nuts, screws, fittings, keys, hinges, wire, cable, gasket material, tubing, hose, and so forth, and are obtainable from a wide range of sources, shall be identified by part number or the notation "Commercial" instead of a part number. The part name (nomenclature or description) shall be complete enough to facilitate substitution of equivalent items from existing Government stock as in the table below.

2.1.2.12. Illustrations

Manuals shall contain illustrations (line drawings, photographs, or halftones) for locating and identifying all components significant to operation and maintenance and to show configuration and parts relationship for removal and disassembly procedures. When photographs are used, they shall be prescreened and shall be detailed and sharp, free of heavy shadows, distorted objects, cluttered foregrounds or backgrounds, and give good contrast from white, middle tones, and black. Free hand sketches shall not be acceptable.

2.1.2.13. Diagrams

As applicable, the following diagrams shall be included in the manual:

2.1.2.13.1. Simplified functional block.

2.1.2.13.2. Locator.

2.1.2.13.3. Schematic.

2.1.2.13.4. Electrical.

2.1.2.13.5. Digital.

2.1.2.13.6. Other, as necessary.

2.1.2.14. Symbols

Symbols used on illustrations and diagrams shall be standard or common to the trade or commodity. Where nonstandard symbols are used, explanations shall be provided.

2.1.2.15. Operating instructions

2.1.2.15.1. Illustrations and explanations of the uses and functions of all controls and indicators (including settings and readings, if applicable).

2.1.2.15.2. Initial adjustments and control settings.

2.1.2.15.3. Start up procedures.

2.1.2.15.4. Normal operation.

2.1.2.15.5. Operation under emergency, adverse, or abnormal conditions (if different from normal operating procedures).

2.1.2.15.6. Shut down procedures.

2.1.2.15.7. Emergency shutdowns (if required).

2.1.2.16. Interface instructions.

2.1.2.17. Maintenance instructions

The Contractor shall deliver instructions, and all data necessary, to perform planned and corrective maintenance at the Organizational/Field Level (O-Level). Instructions shall include a list of test equipment, special tools, and materials needed for maintenance and service. This list shall include nomenclature, part and model number, application, range, and accuracy.

Instructions or illustrations shall explain or show how test connections are made. Actions and normal indications shall be defined for each test. Delivered data shall be of sufficient detail to fully document all maintenance actions.

2.1.3. The Contractor may supply existing Military Specification Technical Manuals for CFE as required by the CDRL provided the existing Military Specification Technical Manual is applicable to the CFE with regard to configuration. The Contractor shall validate that both Commercial and

Military Specification Technical Manuals are applicable to the equipment being supplied.

3. Technical Data Validation

3.1. The adequacy and accuracy shall be validated of all delivered technical data. Validation is defined as the final quality assurance iteration required of the contractor or developing activity during which the technical manual is tested for technical adequacy and accuracy and compliance with the provisions of the specifications and other technical contractual requirements. Validation is normally conducted at the developing activity or vendor's facility. In extenuating circumstances, validation may be conducted at an operational site with prior Contracting Officer approval. Changes/Faults shall not be introduced into systems, equipment, firmware, or software for the purpose of technical manual validation. A

Technical Manual Validation Certificate shall be prepared in accordance with MIL-DTL-24784A and delivered with every technical publication. (CDRL A004)

3.2. The Contractor shall validate all Data Modules against the S1000D Schemas prior to delivery.

3.3. One of three methods shall be employed for accomplishing the validation of technical data, using the criteria in Section 3.4 of this TMCR.

3.3.1. Physical performance method (Type 1). This method consists of physically performing the procedures using the required systems, equipment, and/or software. Physical performance shall include validation of set-up, alignment, operating, troubleshooting and maintenance procedures.

Physical performance shall not involve installation, removal, disassembly, and re- assembly of equipment unless these are the only steps by which to validate the technical manual. Physical performance requires that alignment of the systems, equipment, and/or software to be in accordance with the cutter specifications and that support equipment and tools, be those planned for Coast Guard use. In the event some support equipment or tools are not available, suitable substitutes may be used. The substitute items shall be reviewed to ensure there is no degradation of validation.

3.3.1.1. Walk-through simulation method (Type 2). This method consists of on-site determination that the steps of the procedures are correct and can be physically performed.

Prerequisite procedures must be considered. Hardware configuration must be noted, as well as interfaces between tools and support equipment. The Contractor shall ensure that references to other technical manuals or publications are appropriate and accurate.

3.3.1.2. Review/analysis method (Type 3). This method consists of desktop review to check the technical integrity of data. Equipment substitutions or anomalies occurring during the validation will be noted. Type 3 Validation may include, but is not limited to, the following:

3.3.1.3. Review of removal, replacement, and troubleshooting instructions for technical adequacy and accuracy.

3.3.1.4. Review of maintenance functions and categories.

3.3.1.5. Review of technical manual schematics, diagrams, wiring data, and descriptive data against construction and equipment drawings for accuracy/adequacy.

3.3.1.6. Review of parts lists, recommended spares lists, special tools, and test equipment required.

3.3.1.7. Ensure adequacy of illustrations and that illustrations agree with text.

3.3.1.8. Ensure references to technical manuals are appropriate and accurate.

3.3.1.9. Validation of Data Modules against the appropriate Schema.

3.4. Validation Criteria

3.4.1. Type 1 Validation shall be used to the maximum extent practicable for all technical data.

3.4.2. Type 2 Validation shall be used only when Type 1 Validation cannot be used or is impractical.

Conditions resulting in the use of Type 2 Validation shall include the following:

3.4.3. Whenever procedures would require destructive action, action that introduces permanent modifications or permanent faults, or action that requires removal and replacement of soldered or welded components.

3.4.4. Where procedures could result in injury to personnel or damage to equipment.

3.4.5. Type 3 Validation shall be used only when Type 2 Validation cannot be used or is impractical and when Contracting Officer approval has been obtained.

4. Delivery

4.1. The Contractor shall deliver all Technical Manuals and associated deliverables in electronic format on

CD/DVD, approved file transfer site or another avenue as approved by the Government.

5. References

5.1. Department of Defense specifications.

The requirements contained within this document, were derived from the specifications listed below.

MIL-DTL-24784C Detail Specification, Manuals, Technical:

General Acquisition and Development Requirements, General

Specification for

MIL-DTL-24784/4C Detail Specification Sheet: Commercial Off-The-Shelf (COTS) Equipment Manual Requirements

MIL-STD-38784A Manuals, Technical: General Style and Format Requirements

MIL-PRF-32216A Evaluation of Commercial Off-the-Shelf (COTS) Manuals and Preparation of Supplemental Data

(Copies are available online at http://quicksearch.dla.mil or from the Standardization Document Order Desk, 700

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

5.2. Data Item Descriptions (DIDs).

DI-TMSS-80527C Commercial-Off-The-Shelf (COTS) Manuals and Supplemental Data

(Copies are available online at http://quicksearch.dla.mil or from the Standardization Document Order Desk, 700 Robbins Avenue, Building 4D, Philadelphia, PA 19111-5094.)

http://quicksearch.dla.mil/ http://quicksearch.dla.mil/