A108 Commercial Technical Manual, Equipment/ General Purpose and Supplemental Data

BLOCK 1-DATA ITEM NO.: A108
BLOCK 2-DATA ITEM TITLE: COMMERCIAL TECHNICAL MANUAL, EQUIPMENT/ GENERAL PURPOSE AND SUPPLEMENTAL DATA
(See Attachments 1 and 2 to Data Item No. A108)

This document is also available in word format. Click here to access it.

BLOCK 3-DATA DESCRIPTION:

Commercial Technical Manual, Equipment/ General Purpose and Supplemental Data shall be in sufficient depth for operation and maintenance of equipment by the intended operator/user without the services of a manufacturer’s representative. Manuals shall include all information necessary to perform shipboard (organizational) and depot level maintenance and shall include a hierarchically structured Illustrated Parts Breakdown (IPB). No manual shall omit maintenance or logistics information for any equipment or component thereof designated repairable regardless of the location of the designated repair point. Format and content shall be in accordance with Attachment 1 to Data Item No. A108. For additional guidance see Attachment 2 to Data Item No. A108

REVIEW REQUIREMENTS:

Approval required for content and technical adequacy. Allow 90 days for NASSCO/Government review and comment.

SUBMITTAL SCHEDULE:

Preliminary copy due NLT 60 days after release of equipment for manufacture or release of purchase order to supplier when purchases are off-the-shelf; final manuals are required NLT 90 days after approval of preliminary manuals.

ATTACHMENT 1 TO DATA ITEM NO. A108

COMMERCIAL TECHNICAL MANUAL, EQUIPMENT/ GENERAL PURPOSE AND SUPPLEMENTAL DATA

  1. Manufacturer’s commercial technical manuals, which are technically adequate and accurate, are acceptable for all equipment. However, acceptance of a manual will not be based on content alone, but on the convenience of using the manuals. for example, legibility and size must be taken into consideration. (Manuals with pages smaller than 4 by 8 inches, or greater than 17 by 11 inches, or with smaller than 8-point type for text, or 6-point type for parts list, are not practical and will be reviewed on a case by case basis). Printed copies must be clear and legible, and must be permanently bound to preserve manual in a shipboard environment.
  2. Cover and title pages of technical manual shall contain the following information: 
    1. Manufacturer’s Name and Address
    2. Equipment Name and Application
    3. Hull Number and Ship ClassDate of Applicability
  3. The writing style shall ensure that manuals are understood and used by operation, installation and maintenance personnel. Mathematical explanations will not be presented unless no other method is suitable. Manufacturer’s literature generally intended for sales promotion will not be accepted as meeting requirements for manuals. Manufacturer’s technical data bulletins or cut sheets will be provided. When the primary equipment manufacturer incorporates components from another manufacturer into his equipment, the primary manufacturer will furnish complete documentation on purchased components. Layout shall conserve space without lessening usability or clarity of material. Blank pages and spaces shall be avoided whenever possible. Leading spacing shall be used for best legibility and conservation of space. Double spacing of text is not acceptable. Slight variations are permitted to avoid layout practices that would result in the following: 
      1. The first line of the paragraph being at the bottom of the page.
      2. The last line of a paragraph being at the top of a new page.
      3. A sidehead falling on the last line of a page.
      4. Warnings, cautions, notes being divided so that the first lines appears on one page and the remaining lines on another.  
  4. Digitizing requirements for technical manuals is as follows: : 
    1. System and equipment technical manuals in hard copy only shall be scanned into a digital format using Searchable Adobe Acrobat 4.0TM, or later, incorporating a full search capability. These major equipment/ systems include, but are not limited to: (1) propulsion and electric generation plants; (2) ship service generation plants; (3) emergency power generation plants; (4) steering systems; (5) machinery control systems; (6) switchboards/switching gear; (7) communication and navigation equipment; (8) refrigeration plants; (9) lubrication and fuel oil systems; (10) sanitation and vacuum sewage systems; and (11) cargo handling and UNREP equipment. 
    2. Equipment, such as, minor pumps, motors, or galley equipment, etc., shall be scanned into a digital format using Searchable Adobe Acrobat 4.0TM, or later, incorporating a limited navigation capability.
    3. Equipment, such as, machine shop equipment, office equipment, etc., operator type manuals shall be scanned/converted to RASTER image only “What You See Is What You Get (WYSIWYG)” format
      Warnings, cautions, notes being divided so that the first lines appears on one page and the remaining lines on another.

ATTACHMENT 2 TO DATA ITEM NO. A108

INTEGRATED LOGISTICS SUPPORT (ILS) REQUIREMENTS FOR TECHNICAL MANUALS

This document provides guidance and information with respect to the Technical Manual requirements as referenced in the “Supplier Data Requirements” (attachment [A]), item 065, to this purchase specification. This document does not supercede in any way the requirements of CDRL A108, but is provided as guidance as to the information required by NASSCO to meet the requirements of the aforementioned CDRL.

  1. Preliminary technical manuals will be in Original Equipment Manufacturer’s (OEM) normal commercial format and be of sufficient depth for operation and maintenance of equipment by Military Sealift Command (MSC), USCG Licensed Engineers, without the services of a manufacturer’s representative.  

    The intent of this requirement is to enable ship operators to perform maintenance and repairs with the aid of written instructions and procedures. Manuals shall include all information necessary to perform shipboard (organizational and intermediate) level and depot level maintenance.  

    Definitions of required maintenance levels are as follows: 

    • Organizational – Routine scheduled/preventive maintenance requirements.
    • Intermediate – Service technician level repairs up to and including those requiring standard industrial tools and shop equipment support.
    • Depot – Scheduled overhauls and repairs needing manufacturer or full service repair facility support.

    Manuals shall also include hierarchically structured Illustrated Parts Breakdowns (IPB) that show assembly, subassembly, and component part interrelationships including functionally significant attaching hardware. Commercial parts (i.e. pipe, tubing, and conduit) not customized for specific applications can be identified by drawing, piece number, commercial description, and dimensions, and do not require OEM CAGE and part numbers. Parts breakdown beyond the circuit board level are not required. Three-dimensional, isometric exploded view diagrams are preferred, but are not required. Equipment layout drawings may be used in conjunction with sub component drawings to define complete assembly details. It is not necessary to identify all sub component parts on the parent drawing providing that they are clearly identified on associated sub-tier documents. 

    Technical manual requirements shall be met using the OEM’s commercially available manuals to the maximum extent possible, with separate supplements for additional data requirements as stated herein. Data is required to support all repairable equipment (as determined by the OEM), components, assemblies, and subassemblies regardless of their designated repair point. Maintenance procedures should identify required sealants, solvents, and lubricants by generic specification or readily identifiable Brand Names. Repair procedures considered to be “proprietary” are to be clearly identified, and will be addressed on a case by case basis. 

    OEM CAGE Code numbers must also be provided for all parts. Where OEM CAGE code numbers are not available, the major equipment supplier shall provide associated part numbers with detailed specification and performance information. Equipment, components, assemblies, and/or subassemblies containing replaceable parts, determined by the OEM to be non-repairable by the end user, must be identified in OEM documentation. Equipment, components, assemblies, and/or subassemblies containing replaceable parts, determined by the OEM to be non-repairable even by the OEM, will not require parts breakdown beyond the end item. 

    In order for NASSCO to meet its submittal requirement to the Government and ensure data availability for downstream product development, five (5) hardcopies and one digital copy of the preliminary manuals are required to be submitted NASSCO 60 days after award of RFM or after Purchase Order award for COTS equipment. Critical path long lead equipment submittals may be submitted incrementally with prior consent.

    Digital copy will be in MS Word ’97, Excel ’97 (for tables and charts only), or searchable PDF as required by the appropriate section of the purchase specification.

  2. Final technical manuals will consist of one (1) reproducible hardcopy and one digital copy. Final manuals are required 90 days after approval of preliminary manuals and will include corrections to all technical and legibility discrepancies noted during preliminary review. NASSCO is responsible for duplication of additional hard copies required as deliverables to the Government.
  3. Technical manuals for follow-on ships will consist only of updated technical manual pages as required to identify changes to equipment configuration. This includes changes in the manufacturer of piece parts even thought the part may be the same fit, form, and function. If no changes in equipment configuration have been made, a simple statement of identicality to equipment previously provided will fulfill all ILS data requirements. Change of flight modifications requiring documentation changes in excess of 25% will require full submittal of updated/revised technical manuals.
  4. A full copyright release for all ILS documentation (with the exception of documentation for stand-alone minor COTS equipment, such as printers, and computer users guides for which release cannot be obtained) is required. Title, ownership rights, and intellectual property rights in and to the documentation shall remain with the manufacturers and suppliers. Access to, and use of, the copyright information will be exclusively for the purposes of performance of the Contract Work. NASSCO assumes that the technical documentation contains no material from other copyrighted or proprietary works that have been used without the written consent of the copyright owner and/or the owner of any other rights.

Rev. 2 dated 20 October 2003