MIL-HDBK-59A APPENDIX B APPENDIX B APPLICATION GUIDANCE FOR ACQUISITION OF DIGITAL DELIVERABLES 71 MIL-HDBK-59A APPENDIX B THIS PAGE INTENTIONALLY LEFT BLANK. 72 MIL-HDBK-59A APPENDIX B 10 SCOPE 10.1 Applicability. This appendix provides guidance to government activities on acquisition of digital deliverables in the functional areas that currently produce the greatest volume of hard copy technical data. It is applicable to all Department of Defense (DoD) components which acquire weapon systems and equipment. 10.2 Purpose. This appendix provides decision guidance and model language for tailoring the wording of standard DoD Requests for Proposal (RFPs) and Contract Data Requirement Lists (CDRLs) | to allow and encourage the integrated preparation and submission of, or access to, digital data for design, manufacturing, and support applications. 20 REFERENCED DOCUMENTS See list of references appearing in Appendix A. 30 DEFINITIONS See list of terms and acronyms appearing in Appendix A. 73 MIL-HDBK-59A APPENDIX B 40 GENERAL GUIDANCE 40.1 Contracting for digital data. A major thrust of the Computer-aided Acquisition and Logistic Support (CALS) program is delivery of, or access to, weapon system data in digital form. A second major thrust is the integration of the data bases which produce that data and make it available for use. Implementation of these thrusts requires changes to DoD solicitations and contracts, including their attachments and enclosures. These changes should be made with full consideration of the ability of contractors to provide digital data and the ability of government activities to make cost effective use of digital data deliverables or access. 40.2 Development of the Government Concept of Operations (GCO). | As discussed in Sections 5.1 and 5.2, before preparing a Request | for Proposals (RFP) the government acquisition manager should | develop a GCO to include plans for data management, integration | and use of digital data for weapon system acquisition, design, | manufacture and support. In developing this strategy, the | acquisition manager must assess current government capabilities | and future plans to acquire and use systems to access, receive, | store, process and distribute digital technical data formatted in | accordance with CALS requirements. Key factors to be assessed | include timeframes and actions for implementation of CALS- | compliant capabilities for each data product applicable to the | acquisition. Before digital data delivery or access is | specified, the acquisition manager should evaluate productivity | and quality gains to be achieved as a result of using technical | data in digitized format. Once the strategy is defined, the | acquisition manager should specify the contractual requirements | for a contractor service, the Contractor Integrated Technical | Information Service (CITIS), to access and use contractor data. | The requirements for this service should be specified in the RFP. | CITIS would provide access to the integrated data in the | underlying contractor(s) system(s). DoD has produced an | Acquisition Guide to help acquisition managers incorporate the | requirements for this service in contracts. DoD is currently | developing a CITIS Functional Specification (MIL-F-CITIS (DRAFT)) | which will define the baseline functional requirements for the | service and provide instructions for tailoring the service and | developing contract language to satisfy the unique needs of each | acquisition program. | | When evaluating government plans to implement automated | systems for utilization of technical data in digital form, the | acquisition manager should bear in mind that some data products | can be delivered or accessed in accordance with a mutually | 74 MIL-HDBK-59A APPENDIX B agreeable, popular word processing package. Types of data | products which are conducive to this method of data interchange | include program management reports, technical review | documentation and acquisition planning documentation such as | technical manual plans and quality assurance plans. Generally, | these types of documents have a relatively short lifespan and | limited user community, and are less complex with respect to | their graphics and publishing requirements. | | In contrast, engineering documentation and logistic support | information have a long lifespan, are stored in data repositories | for access by a broad user community, and are prepared to satisfy | more complex requirements. The acquisition manager's data | management strategy should include integration and use of these | high-volume types of technical data in accordance with guidelines | provided in this appendix. This integration should be provided | by the underlying contractor system(s) which is accessed through | the CITIS. | 40.3 Tailoring and revision of functional standards. Existing functional standards may be insufficient to invoke these alternatives contractually. Many of these standards were written to address not only hard copy delivery requirements, but also style and format provisions designed for the paper environment. Therefore, tailoring is frequently required when they are cited by the contract. In some cases, tailoring out inappropriate requirements may be insufficient, and alternative language may be needed as part of the statement of work. The acquisition manager should identify necessary changes to functional standards and forward them to the appropriate preparing activity to facilitate revision and publication of updated functional standards. 40.4 Application of the master decision template. The master decision template (Figure 1, 5.2.4) provides guidance for analysis of how technical data should be acquired by the government from the contractor. This appendix discusses the application of the master decision template to specific functional areas, including the appropriate technical standards and specifications. 40.4.1 Tailoring to meet program requirements. In each case, the master template must be tailored to meet the requirements of the functional area. In addition, each weapon system program may include unique requirements for which additional program-specific tailoring will be needed. Most of the applicable CALS standards and specifications contain contract-negotiable options among which the acquisition manager must choose to satisfy program- specific requirements, including multiple classes or types of data formats, and different requirements for interim and final 75 MIL-HDBK-59A APPENDIX B deliverables. Consequently, the acquisition manager must apply this handbook as a guidance document, not as a rulebook. 40.4.1.1 Classes of data. Section 1 (scope) and section 6.2 (ordering data) of a military specification will list classes (types, levels) of data addressed by the specification. Usually, the acquisition manager must choose one of these classes based on the program's information requirements. For example, MIL-D-28000 includes several data classes, including Class I for technical illustrations, Class II for engineering drawings, Class III for electrical and electronic applications, and Class IV for numerical control machining data. Class I is usually most suitable for technical manuals, class II for engineering drawings and book form drawings, etc. 40.4.1.2 Contract negotiable options. Section 6.2 (ordering data) of a military specification also summarizes other contract- negotiable options allowed to be ordered under the specification. For example, MIL-M-28001 requires delivery of an SGML-tagged source file as a final deliverable. However, it also allows delivery of a page description language (PDL) file as an interim deliverable or as a second final deliverable. 40.4.1.3 Data delivery procedures. CALS military specifications provide technical requirements for delivery of digital data. MIL-STD-1840 provides rules for organizing files of digital data (for example, MIL-M-28001 text files and MIL-D-28003 graphics files) into a complete data package, such as a technical manual in digital form. Therefore, in most cases delivery of digital data must be specified in accordance with both MIL-STD-1840 and one or more appropriate military specifications. | 40.4.2 Selection of multiple options. The alternatives contained in the decision template are not mutually exclusive, and are applied individually to each technical data requirement within the functional area. For example, the acquisition manager may choose digital document image data for preliminary review and approval, and processable data files for final deliverables. However, early selection (or rejection) of one deliverable option may cause that option or other options to be excluded from further consideration for deliverables in subsequent program phases. For example, an early decision to require technical illustrations in raster form may result in creation of data that cannot easily be converted to vector form. 40.4.3 Data item descriptions (DIDs). A DID identifies specific | data requirements, which may include the format of a report used to display the data. Most current DID's were prepared with only the hard copy (paper, aperture card, etc.) document environment 76 MIL-HDBK-59A APPENDIX B in mind. In a CALS environment, two aspects of data acquisition must be examined to determine whether existing DID's are adequate: the deliverable itself (documents, processable data files, interactive access), and the delivery mode (physical media or telecommunications). 40.4.3.1 Documents and media. If a document is acquired, in either hard copy (paper, aperture card, etc.) or digital document (raster, PDL, etc.) form, then this requirement is not additive to the basic set of data requirements and the existing DID can be used without revision. Similarly, a new DID is not required when a physical media delivery mode is specified, because this requirement is not additive to the basic set of data requirements. If a telecommunications delivery mode but not interactive access is specified, a new DID is also not required. | The delivery mode (magnetic tape, disc, telecommunications, etc.) | and interchange standard (MIL-STD-1840A) shall be identified in | Block 16 of the Contract Data Requirements List (CDRL). | 40.4.3.2 Processable data files. The basic set of data require- ments does change when processable data files are acquired, even though the exact same data elements are included. Therefore, | DIDs for processable data files must specify the data elements | and data relationships comprising the processable files or data | base. The physical media for exchange will be specified in Block | 16 of the CDRL. | | 40.4.3.3 CITIS. In the case of CITIS, the acquisition manager | is acquiring a service as well as deliverable documents or a data | product. In this case, the requirements for access to and | interaction with the data base (system availability, maximum | response time, query capability, equipment, etc.) will have to be | addressed in the contract statement of work. The DID to be cited | in the CDRL shall define the data product in terms of the data | elements and data relationships that comprise the data base which | is to be accessible. This information is used to define data | integration requirements for the underlying contractor system. | For large efforts, data relationships will be defined according | to specified user views. The CITIS will provide the interactive | access capability to the underlying system(s). DoD has developed | an Acquisition Guide and a Draft CITIS Functional Specification | to assist acquisition managers define and incorporate | requirements for CITIS in contracts. | | 40.4.3.4 DID preparation and management. The same procedures | that are followed in preparing and managing DIDs for hard copy | data products apply to DIDs for processable data files and | interactive access to data bases. DOD Directive 5010.12, DoD Data | Management Program, and DOD-STD-963, Preparation of Data Item | 77 MIL-HDBK-59A APPENDIX B Descriptions explain these procedures. | 40.5 Technology development and insertion. One characteristic of CALS system integration initiatives will be application of new technology that is currently still in the research and development process. However, the technology for interfacing systems is also evolving. This is reflected in all aspects of technical data delivery and access, and in the telecommunications and computer-aided capabilities through which data delivery and access is implemented. Data which cannot cost effectively be provided through interactive access today will be routinely exchanged using this medium in the future. New specifications and standards will be developed and implemented to allow digital documents and processable data files to be more efficiently managed. Computer system vendors will provide more capable hardware and software that can integrate processable data files through which different forms of data (text, graphics, etc.) are treated as a single, compound data structure. Acquisition managers should be alert for opportunities to apply this more advanced technology, as well as cautious about premature implementation. CITIS and government technical information system architectures must plan for technology insertion, and for the attendant problems of managing both multiple concurrent capabilities (e.g., raster and vector graphics) and multiple concurrent technology levels (e.g., untiled and tiled raster). 78 MIL-HDBK-59A APPENDIX B 50 DETAILED GUIDANCE 50.1 Organization of guidance sections. This appendix is organized by functional area. Each section can be used separately or in combination with others to contract for digital CALS data. The functional areas covered in this release of MIL- HDBK-59 are: a. 50.2 Technical Manuals. b. 50.3 Technical Data Packages (including Engineering Drawings, Product Specifications and Book Form Drawings, Electrical/Electronic Item Product Data, and other Technical Data Package components). c. 50.4 Logistic Support Analysis Records. d. 50.5 Training Products. Among the functional areas that will be included in future releases of MIL-HDBK-59 are: a. 50.6 Technical Specifications and Reports. b. 50.7 Maintenance Information for Interactive Presentation. c. 50.8 Integrated Diagnostics 50.2 Acquisition of technical manuals 50.2.1 Scope. This section addresses the selection of digital data deliverables for technical manuals (technical orders in the Air Force). Technical manuals are the operating and maintenance instructions for military technicians. They contain a combination of textual narrative and illustrative graphic images presented in a formal, structured, page-oriented format governed by specific functional standards. These manuals have traditionally been prepared and delivered in hard copy form as camera-ready copy, which are, in turn, printed in large lots. 50.2.1.1 Digital data deliverables. The implementation of automated data processing technology offers numerous improvement opportunities in both preparation of technical manuals, and the delivery, storage, distribution, and maintenance of manuals. Technical manual data in digital form can be stored on magnetic or optical media, transmitted and shown on computer terminals, and printed on demand. Acquiring technical manual deliverables 79 MIL-HDBK-59A APPENDIX B in digital form allows the military user to view required information without printing it on paper. Acquiring processable data files provides the opportunity to tailor outputs for particular users and uses. Data can be reformatted into step-by- step trouble-shooting formats for maintenance personnel, it can be adapted to expert system diagnostic programs, or it can be used to generate training aids. 50.2.1.2 Advances in computer capability. Many of today's computer systems still manage and interchange textual data differently from graphics data, making it difficult to insure consistency between the narrative and illustrative materials required in technical manuals. Technology and standards are | being developed and implemented to overcome this problem, and | will become increasingly available. Contractors will implement this technology rapidly, and acquisition managers should anticipate improved tools for maintaining and delivering technical manual data. 50.2.1.3 Master library data elements. Acquisition managers | should also seek improved methods and procedures for indexing, | tracking, and controlling information relating to technical | manuals. Military specification MIL-M-29532 (EC) provides a | uniform set of data elements necessary to track and control | information in technical manuals at the master library level. The | specification provides a method to index technical manuals and to | interchange indexed information between contractors, government | data repositories, and user communities. MIL-M-29532 (EC) is | intended to be applied to technical manuals which have been | encoded as document image files, often in raster format via | scanning of existing documents. This indexing is necessary for | access to appropriate page images without requiring a sequential | visual search from the beginning of the file. Other computer | sensible encoding techniques, such as SGML, can be considered | self-indexed and do not require a separate index. | 50.2.1.4 Data sources for technical manuals. The Logistic Support Analysis Record (LSAR) consolidates logistics-oriented technical information in conjunction with data for the various engineering disciplines and Integrated Logistic Support elements to reduce redundancy, facilitate timely usage, and enhance consistency among data elements and disciplines. The quality and productivity of technical manual development is enhanced when the LSAR is used as a principal data source for this process. Integration of the data bases that produce LSAR task analysis (and other) data, technical manuals, and training materials will provide even greater benefits. 80 MIL-HDBK-59A APPENDIX B 50.2.2 Decision node discussion. Figure 4 applies the master Decision Template for Acquisition of Digital Deliverables to technical manual deliverables. The following paragraphs discuss the required decisions shown in Figure 4. FIGURE 4. Decision template for technical manuals. 50.2.2.1 Deliverable options - decision #1. Technical manual data can be delivered as composed documents, processable files, | or through interactive access via CITIS. The composed document | deliverable option offers the least flexibility, even in digital form. It is a static, formatted presentation of the manual, which can only be archived, viewed, and printed after receipt. Processable files, on the other hand, offer more robust capabilities. These files can be updated or transformed into many different data types. With appropriate data processing systems, processable files can support creation of job guides, training documents, and eventual on-line distribution of selected portions of the data to maintenance personnel. In addition, a 81 MIL-HDBK-59A APPENDIX B separate indexing mechanism may be needed for either machine or human search or access. 50.2.2.1.1 Destination system constraints on form. Processable data files are preferable to composed documents, but the presence of both text and graphics may cause some difficulty because not all presently installed computing equipment and software can simultaneously process text with embedded graphics. This issue is rapidly disappearing. Nonetheless, during the period of intended use, installed hardware and software at both the contractor's site (i.e., the source system) and government's site (i.e., the destination system) will be the deciding factor as to which form the deliverable may take. 50.2.2.1.2 Interim dual deliverables. Requirements for technical manual deliverables may include both composed documents in digital form and processable data files. However, until more advanced government systems are available, it may be necessary to accept, for each deliverable, both one hard copy (paper) technical manual for approval and reproduction/distribution, and a digital form of that manual for archiving or update and maintenance. When the government implements more advanced computer systems, processable technical manual files (with or without composed document image files of the technical manual) should suffice. Check with the appropriate Service CALS point of contact (Appendix A) for up-to-date guidance. 50.2.2.2 Forms options - decision #2. A technical manual is made up of both text (including narrative and tables) and graphics. Integrating these elements into a complete technical manual, and dealing with user requirements that are different for interim review and approval than for final delivery, may require more than merely choosing a single optimum form. The acquisition manager may have to choose the appropriate forms for multiple deliverables (e.g., a processable data file that can be updated and maintained, plus a document image file that can be displayed and printed on demand), or for the elements of a single deliverable (e.g., processable data files for text, and document image files for graphics). 50.2.2.2.1 Forms options - decision #2 (for composed documents). As shown at the top left of Figure 4, if composed documents have been selected at decision #1, the forms for technical manual delivery can be either hard copy (paper or microfilm) or a digital composed document image file. The digital form of this deliverable consists of composed page images of the full manual. It offers greater advantages than hard copy in storage, distribution, viewing, and printing. It also provides slightly more flexibility than hard copy with respect to future data uses, 82 MIL-HDBK-59A APPENDIX B although its format will be fixed and unyielding. It is a two- dimensional image of each manual page, offering no further updating or processing features beyond replication. Neither the hard copy nor the digital form supports update or maintenance except with great difficulty. 50.2.2.2.2 Forms options - decision #2 (for processable files). If processable files are selected at decision #1, the forms for technical manual delivery can be either one or more sets of text and graphics files, or an integrated data file that contains text and graphics in a compound data architecture. The use of an integrated data file is a future option. At present, a processable technical manual file will be comprised of one set of files for textual or numeric data and a separate set of files for graphic illustrations and drawings. In the future, these same text and graphics data will be available as integrated data files with configuration management and positioning features. However, the technologies to accomplish such integration are just beginning to be introduced. 50.2.2.2.3 Forms option - decision #2 (mixed mode). A technical manual typically contains about 60% text and 40% graphics. The graphics may include illustrations imported from a design data base, artwork that has been newly created on an advanced authoring work station, and illustrations originally created on the drafting table that must now be treated as a digital image. The text will include both straight narrative and tables, and the tables may be so elaborate that it is technically easier to construct them as if they were a graphic illustration, rather than organized textual information. In cases such as this, the digital deliverable may be made up of files of processable data (e.g., the text and the graphics imported from design) accompanied by composed document image files (e.g., illustrations that have been raster scanned from hard copy artwork). See the discussion of raster versus vector graphics below. 50.2.2.3 Specification and standard options - decision #3. 50.2.2.3.1 Decision #3 for composed documents. Technical manuals acquired as composed documents may be acquired in the form of either camera-ready masters or digital document image files. The intended application may also require an additional indexing mechanism for efficient subsequent processing. Camera- ready masters should be delivered in accordance with MIL-M-38784 or other appropriate MIL-SPECs or MIL-STDs. Digital document image files in raster form should be acquired in accordance with MIL-R-28002. MIL-R-28002 provides two options: Type I (the default option) for untiled raster data, and Type II for tiled raster data, for which a new international standard is being | 83 MIL-HDBK-59A APPENDIX B developed. The term "tiled raster data" refers to drawings that | are segmented into several grids of small blocks containing | raster data. These blocks of data are compressed individually to | form a complete raster drawing. Modifications to a tiled drawing | are easier to control since only those small blocks of data | requiring changes are modified. Storage of document images in a | Page Description Language (PDL) provides an alternative form which is slightly easier to maintain. A PDL file is a program that is executed by an interpreter that controls a raster printer or other output device. PDL document image files can be acquired as interim deliverables, or as final deliverables in addition to (but not in place of) processable data files using MIL-STD-1840 and MIL-M-28001. However, these are not standardized, for a Standard Page Description Language (SPDL) is still being developed. 50.2.2.3.2 Decision #3 - specifications and standards for graphics. 50.2.2.3.2.1 Raster versus vector graphics. Graphics data may be in either raster or vector formats. Assuming an adequate scanning resolution, raster provides nearly exact fidelity for illustrations, whereas vector graphics translates data between different sending and receiving system native forms. (For example, a line expressed as a pair of end points, versus a line expressed as an origin, direction, and length.) This can introduce errors, even when an intermediate neutral format (the standard) is agreed upon. Vector representations are easily edited, maintained, and updated, whereas raster representations can be edited only with great difficulty. Vector representations also have the advantage of much smaller file size, even when the raster bit-map image has been compressed using an algorithm such as that specified by MIL-R-28002. Nevertheless, raster graphic illustrations are frequently encountered because scanning remains the only practical way of converting a legacy of hard copy drawings into digital data. Despite the limitations of raster data, the practical consequence of the hard copy legacy requires supporting both raster and vector formats for graphics. Raster illustrations belong to the class of document image files discussed in the previous paragraph and should be acquired using MIL-R-28002. 50.2.2.3.2.2 Specifications for vector graphics. There are two choices of standards to consider for vector graphics: MIL-D- 28003 for CGM and MIL-D-28000 for IGES. Generally, the Computer Graphics Metafile (CGM) is appropriate for graphics in the categories of illustrations, charts, etc., while engineering drawings and technical illustrations derived from design data are the domain of IGES, the Initial Graphics Exchange Specification. 84 MIL-HDBK-59A APPENDIX B CGM files are smaller than equivalent IGES files by a factor of up to four. For technical manuals, CGM is the preferred option but IGES is allowed. Extensions to the standard to allow translation of native CAD data into CGM are still being developed. If technical manual illustrations are being derived directly from design data, then system limitations may constrain the choice of delivery standard. In selecting the appropriate option, the acquisition manager should recognize the potential problems created by multiple translation steps (e.g., unique CAD system to IGES to CGM). MIL-D-28003 specifies an Application Profile with two options: Level I for publication quality data, and Level II for draft quality data. With some effort, | uncompressed raster data can be included in a CGM file, but MIL- | D-28003 should only be used where the predominate form of the graphics information is vector. MIL-D-28000 specifies several subsets of IGES designed to meet different application needs. In most cases, when IGES is used for technical manual illustrations, the Class I Technical Illustration subset is appropriate. In a few cases, program requirements may make it appropriate to specify use of the Class II Engineering Drawing subset. In either case, data would be delivered in either ASCII or compressed ASCII, as specified by MIL-D-28000. 50.2.2.3.3 Decision #3 for processable text. Processable text data files should be acquired in accordance with MIL-M-28001, which implements the Standard Generalized Markup Language (SGML). An SGML Document Type Definition and Formatting Output Specification Instance (FOSI) must be selected from MIL-M-28001, or created in accordance with the provisions of MIL-M-28001, to meet the document structure and format requirements of the technical manual. 50.2.2.4 Digital delivery mode options - decision #4. As shown at the right side of Figure 4, physical media are currently the only practical option for the delivery of document image files or processable data files. While telecommunications bulk transfer of these files may be possible, it is usually not an economical option because of the large volume of data contained in these files, particularly the raster document image and raster graphics files. When interactive access to a contractor's technical | manual data base through CITIS is specified (see left side of | Figure), telecommunications will be used as the delivery mode | for deliverables. In a few cases, telecommunications networks | are already being used for on-line review and approval of technical manuals or portions of manuals. 50.2.2.4.1 Decision #4 - magnetic tape. As shown at the far right of Figure 4, the preferred physical media option to use is magnetic tape. Standards for tape media are contained in 85 MIL-HDBK-59A APPENDIX B Appendix D of this handbook. It is a mature, stable technology that is usually available at all sending and destination systems. 50.2.2.4.2 Decision #4 - optical disk. WORM optical disk or CD- ROM will be alternative physical media option in the future, and are generally well suited for data archiving because they can accommodate very large volumes of data quite efficiently. However, because they are relatively new technologies, WORM and CD-ROM may necessitate new hardware investments by both the contractor and the government to accommodate this media, and they | are not yet fully standardized. At present only MS-DOS PC-based | CD-ROM systems are standardized while WORM requires the same | vendor sending and receiving hardware. | 50.2.2.5 Digital deliverable summary. Selection of the options at each node of the Technical Manuals decision template should be aligned to the needs of the organizations responsible for technical manual publication and maintenance within each military department. However, requirements for interim deliverables that are provided only for review and approval (verification) may be evaluated differently than are final deliverables. Delivery of processable data is less important when the principal applications are view and annotate, than when the intended applications are update/maintain and process/transform. Consequently, document image files may be more appropriate early in the life cycle of the program; however, processable data files should be the deliverable of choice when the government assumes the responsibility for technical manual update and maintenance. These files should be usually be delivered on magnetic tape. 50.2.2.6 Example - delivery of digital data into the Automated Technical Order System (ATOS). For example, the appropriate selection options for technical manuals delivered to the Air Force Automated Technical Order System should be processable technical manual files composed of: a. SGML text files in accordance with MIL-M-28001 and MIL- STD-1840. b. Raster graphics files in accordance with MIL-R-28002 Type I and MIL-STD-1840. c. Vector graphics files in accordance with MIL-D-28000 Class I and MIL-STD-1840. 50.2.3 Decision guidelines. As noted previously, digital delivery options for technical manuals are not mutually exclusive. There will often be cases when several options will be combined for specific deliverables during a weapon system 86 MIL-HDBK-59A APPENDIX B acquisition. The decision criteria presented in this handbook are intended to aid in selecting the best options. The following is guidance for applying the criteria to technical manuals. 50.2.3.1 Intended data use. The following general guidelines are provided: a. Select processable files if internal or third party update and maintenance is anticipated, document image files if no further revision or change is anticipated. b. Select processable files if the future creation of specialized documents and aids is envisioned. c. Select vector graphics files if update and maintenance of illustrations and drawings is desired, raster graphic files if hard copy illustrations are being converted to digital form. 50.2.3.2 Life cycle phases. The acquisition life cycle phase of the weapon system and its technical data is an important consideration. The following general guidelines apply: a. Select document image files if a program is in a late phase (i.e., full scale development, or production and deployment) and large amounts of data already exist in hard copy. b. Select document image files for interim deliverables for in-process review prior to assumption of management and maintenance responsibility. c. Select processable data files for final delivery, when maintenance and update responsibility is assumed by the government. 50.2.3.3 Delivery cost. Costs associated with the delivery process are a consideration. The following guideline applies: Select tape for delivery of large volumes of digital data or, where multiple copies of a manual are required, consider | delivery of WORM or CD-ROM disks. | 50.2.3.4 Available technology. The limitations of the government receiving system are a consideration. The following guideline applies: Select document image files if the receiving system lacks update and maintenance capability, processable data files 87 MIL-HDBK-59A APPENDIX B for subsequent processing and transformation. 50.2.4 Contract implementation of digital data delivery. There are five basic, yet non-exclusive, digital deliverable alterna- tives. These are summarized in Table IV. 50.2.4.1 Digital data deliverables. MIL-M-38784, Technical Manuals: General Style and Format Requirements, is commonly used to order technical manuals; other specifications govern specific types of manuals, and are often invoked in conjunction with MIL- M-38784. When delivery (or access) of technical manuals in digital form is planned, all relevant functional standards must be reviewed to ensure that they do not specify requirements which are incompatible with the applicable CALS standards. 50.2.4.2 Ordering requirements. Block 16 of the CDRL (DD Form 1423) should cite delivery of digital data in accordance with MIL-STD-1840. The physical media standards for magnetic tape or optical disk delivery mode shown in Appendix D should also be specified. TABLE IV. Technical manual forms and standards. +-------------------------------------------------------------------+ | Deliverable and | Preferred | Implement With | | Form | Mode | | |------------------------|--------------------|---------------------| | 1. Document Image | Magnetic Tape/ | MIL-R-28002 or MIL- | | File | Optical Disk | M-28001 (PDL only), | | | | MIL-STD-1840, and | | | | optionally MIL-M- | | | | 29532 (EC) | | | | | | 2. Processable Text | Magnetic Tape/ | MIL-M-28001 and | | File | Optical Disk | MIL-STD-1840 | | | | | | 3. Raster Graphics | Magnetic Tape/ | MIL-R-28002 and | | File | Optical Disk | MIL-STD-1840 | | | | | | 4. Vector Graphics | Magnetic Tape/ | MIL-D-28000 and | | File-IGES | Optical Disk | MIL-STD-1840 | | | | | | 5. Vector Graphics | Magnetic Tape/ | MIL-D-28003 and | | File-CGM | Optical Disk | MIL-STD-1840 | +-------------------------------------------------------------------+ 88 MIL-HDBK-59A APPENDIX B 50.3 Acquisition of technical data packages (TDP). 50.3.1 Scope. A technical data package is a technical description that is adequate to support acquisition of an item, including engineering, production and logistic support. The technical description consists of all applicable technical data, such as engineering drawings, associated lists, product and process specifications and standards, performance requirements, quality assurance provisions, and packaging details. This section addresses acquisition of the elements of a TDP. MIL-T-31000 has been prepared by DoD to bring together the | various elements of TDPs into one specification. MIL-T-31000 | supersedes DoD-D-1000 effective 1 July 1990. TDP elements are | intended for use as a basis for design evaluation, competitive | acquisition, installation, maintenance, modification, or | engineering support of military material developed by or for the | Department of Defense. These elements maybe acquired in either | paper or digital form. The data products covered by the new | specification have been previously acquired under a variety of | specifications, standards and data item descriptions. Guidance | for the data products of MIL-T-31000 is included in this handbook | under reference to the older source documents. More direct | references to MIL-T-31000 and its data products will be included | in future editions of this handbook. | | In the interim, the existing guidance should be applied to | MIL-T-31000 data products based on their similarities to the data | products already covered in this handbook. | 50.3.2 Engineering drawings. 50.3.2.1 Scope. This section addresses the acquisition alterna- tives for engineering drawings, a major component of Technical Data Packages (TDPs). The emphasis is on those drawing levels | (as defined in DoD-D-1000) that will be used to manufacture hardware: Level 2 (production prototype and limited production) and Level 3 (production), rather than Level 1 (conceptual and developmental design). Typically, only Levels 2 and 3 are delivered to DoD repositories for archiving and subsequent application and use. This section, and the section on product specifications and book form drawings that follows, distinguish between technical data that is primarily graphic with associated text annotation, and technical data that contain a more proportional mix of graphics and text. 50.3.2.2 Overview. Engineering drawings are documents that disclose directly or by reference, by means of graphic and textual information, the physical and functional end-product 89 MIL-HDBK-59A APPENDIX B requirements of an item. Geometry, material requirements, and process data, along with notational explanations pertaining to specific functions and features of the representation, are its typical contents. Process and manufacturing engineers interpret the drawings and create additional information on the material and physical processes required to fabricate the parts, assemblies, or products described by the engineering drawing. In addition, machine instructions can be created from the drawing by a process engineer to direct the fabrication and inspection processes for parts fabricated on computer numerical control and automated production machines. 50.3.2.2.1 Product definition data. An engineering drawing is a subset of what CAD users have come to call product definition data. Product definition data includes the information needed for design, analysis, manufacture, test, and inspection (see the definitions of the forms of technical data in Appendix A, Section | 30). Product definition data, in turn, is a subset of product data, which adds the elements of life cycle support to those of design and manufacture. Even though an engineering drawing does not contain all product definition data, let alone all product data, it is the accepted form in which product design information is communicated and documented for the record in a hard copy environment. It will continue to serve this same function while users transition into a CIM environment. 50.3.2.2.2 Drawing conventions and standards. Because engineering drawings meet a wide scope of information and user needs, conventions and standards governing their creation have been developed to ensure consistency of creation and interpretation. These requirements have been codified in a hierarchy of military standards and specifications, with DoD-STD- 100 at the apex. 50.3.2.2.3 Evolving technology for engineering drawing data. Some design work is still being done on the drafting table, but users are increasingly adopting computer-aided design (CAD) technology. Regardless of how the engineering data is created, however, it can still be exchanged between users in either hard copy or digital form. 50.3.2.2.4 Use of raster graphics. DoD stores over 200 million engineering drawings and specifications in its repositories, and most of this information is duplicated in the repositories of the defense contractors who created the drawings. The storage of engineering drawings and the generation of spares reprocurement packages has become increasingly difficult and time consuming as the volume of hard copy data in DoD repositories has continued to expand. Thirty years ago, engineering drawing users transitioned 90 MIL-HDBK-59A APPENDIX B from paper/vellum to aperture cards as the medium of interchange for drawings. Now that new technology is available, and storage of engineering drawings on aperture cards can no longer keep up with user needs, the Services' data repositories have initiated the process of raster scanning hard copy engineering drawings for more compact storage on optical disk. While this adds no intelligence to the engineering data itself, it does significantly improve data management capabilities. 50.3.2.2.5 Computer aided design (CAD). Defense contractors are expanding the use of CAD and computer integrated manufacturing (CIM) systems to automate design and manufacturing functions. These CAD and CIM systems create and use vector graphics files, defining the geometry and associated data attributes of weapon system assemblies and components. This technology facilitates use of other automated tools, such as those for reliability and maintainability (R&M) analysis, in the design process. STEP, an evolving DoD and industry-supported data standard for description of the product over its life cycle, will provide additional functionality when it becomes available. STEP used with CIM technology will facilitate the integration of engineering design, manufacturing, logistic support, and configuration management data. Engineering drawings, an output of the engineering design process, will be able to be extracted directly from product data, largely without intermediate manual processes. Ultimately, engineering drawings may no longer be necessary for spares reprocurement, particularly when STEP product data can be directly transferred between CIM systems. 50.3.2.3 Decision node discussion. The master Decision Template for Acquisition of Digital Deliverables is applied to the Engi- neering Drawings Application as shown in Figure 5. Each decision is discussed in the following text. 50.3.2.3.1 Deliverable options - decision #1. The first column lists the first set of deliverable options for engineering drawings. The current choices are engineering drawing images, the more comprehensive product definition data files used by some contractors, or interactive access to the engineering design data | bases through CITIS. | 50.3.2.3.2 Form options - decision #2. 50.3.2.3.2.1 Forms options - decision #2 (for engineering drawing images). The deliverable form options for engineering drawing images are hard copy and raster image files. Paper, vellum, mylar, roll microfilm, and aperture cards are some examples of the media used for hard copy. The aperture card has become the accepted medium for acquiring reproducible hard copy 91 MIL-HDBK-59A APPENDIX B images of engineering drawings, although other forms are still in use. Aperture cards or other hard copy forms delivered to DoD automated engineering data repositories will be converted to raster images for storage. This conversion can be avoided by choosing delivery of a raster image file. Raster image files are the representation of digitally scanned paper drawings or aperture cards. There is no intelligence in the raster image file. Human interpretation is required, as it is with paper drawings or aperture cards. Raster image files are primarily useful for data that are to be used in a print on demand, hard copy (paper or aperture card) mode. FIGURE 5. Decision template for engineering drawings. 50.3.2.3.2.2 Forms options - decision #2 (for product definition data files). The options for product data definition files are the CAD data file and the integrated product data file. The CAD data file consists of vector data with geometrically accurate and precise representations of the product, together with associated 92 MIL-HDBK-59A APPENDIX B annotations (dimensions, tolerances, etc.). This CAD data can be either two-dimensional or three-dimensional, although the CALS standard (MIL-D-28000) described below defines a three- dimensional CAD data file. CAD data contains limited intelligence, and is suitable for automated interrogation and manipulation, such as alternate views of the object or path generation for numerically controlled manufacturing machinery. DoD repositories plan to accept digital data created by CAD systems as input, although in the near term the principal output medium from those repositories will be hard copy or raster images. The integrated product data file will contain more information. It will include three dimensional features, solid | geometric modeling, parametric design, material specifications, | design tradeoffs, process and manufacturing engineering, and machine instructions for automated parts manufacturing. This option requires technologies that are not yet fully developed or in widespread use, and for which standards are still under development. 50.3.2.3.3 Specifications and standards options - decision #3. DoD-STD-100 and MIL-T-31000 are the functional standards | controlling the subject matter and content requirements of engineering drawings. Changes to these standards, or new standards, may need to be developed if current or future CAD technology leads to changes in the subject matter or content of engineering drawings. Technical specifications and standards are well defined for aperture cards, raster image files, and CAD data files. 50.3.2.3.3.1 Specifications and standards options - decision #3 (for engineering drawing images). Aperture cards are governed by MIL-M-38761 and MIL-STD-804 (hollerith data) requirements. MIL- M-9868 governs the microfilming of engineering documents. Raster image files are governed by MIL-R-28002. The default format for delivery of raster data is MIL-R-28002 Type I (untiled). However, MIL-R-28002 Type II (tiled) may be negotiated if the appropriate sending and receiving system capability is in place. 50.3.2.3.3.2 Specifications and standards options - decision #3 (for product definition data files). CAD data files are governed by MIL-D-28000 (IGES). In most cases, the MIL-D-28000 Class II subset (engineering drawings) is appropriate. For electrical and electronic applications, the MIL-D-28000 Class III subset may be more appropriate, Specialized data requirements (which technically are not engineering drawings) should be met with other IGES subsets (e.g., Class IV for numerical control data). In either case, data would be delivered in either ASCII or compressed ASCII, as specified by MIL-D-28000. The STEP standard (when available) for the integrated product definition data file 93 MIL-HDBK-59A APPENDIX B should be considered for future deliverables from programs that are in the very early phases of concept development. However, use of STEP will offer the opportunity to acquire information that exceeds the current scope of engineering drawings, and may require development of new functional standards, or changes to DoD-STD-100 and MIL-T-31000. 50.3.2.3.4 Digital delivery mode options - decision #4. The digital delivery mode options are shown at the right side of Figure 5. Physical media is currently the only practical option for the delivery of raster image files. Telecommunications bulk transfer is possible; however, it is not the preferred method due to cost considerations. Interactive access to the contractor's | data base through CITIS will present the option to access | specific portions of the data as appropriate and, at that time, | telecommunications may be a viable option for certain interim deliverables. An alternative may be to use CITIS Level 1 | services (See 5.2.4.2.3) to locate and order data that is | subsequently delivered using physical media. The preferred | physical media option to use at this time is magnetic tape. Reference the tape media standards discussed in Appendix D of this handbook. 50.3.2.3.4.1 Decision #4 - magnetic tape. Magnetic tape is the preferred physical medium for delivery. It is a mature, stable technology that is usually available at all sending and destination systems. 50.3.2.3.4.2 Decision #4 - optical disk. Optical disk is an alternate physical media due to emerging standards (particularly | for MS-DOS PC-based applications) and the increasing number of | DoD programs using optical disk technology. The major optical disk advantage is its ability to archive and store large volumes of data. 50.3.2.3.5 Digital deliverable summary. In general, the evaluation and selection of options at each decision node of the Engineering Drawings decision template must be aligned to the capabilities of the automated engineering data repository systems of the using Military Department. Raster image files should be acquired early in the life cycle of the program, when the principal application is review and approval. CAD data files could be the final deliverables of choice for drawings obtained for spares reprocurement technical data packages if the data were originally developed on CAD systems. 50.3.2.3.6 Example - delivery of digital data to DoD engineering data repositories. For example, the appropriate selection of options for engineering drawings delivered to the Army Digital 94 MIL-HDBK-59A APPENDIX B Storage and Retrieval of Engineering Data System (DSREDS), the Air Force Engineering Data Computer Assisted Retrieval System (EDCARS), or the Navy/Defense Logistics Agency Engineering Data Management Information and Control System (EDMICS) should be as follows: a. Raster image files delivered on magnetic tape in | accordance with MIL-STD-1840 and MIL-R-28002 Type I. | b. CAD data files in IGES delivered on magnetic tape in | accordance with MIL-STD-1840 and MIL-D-28000 Class II. | 50.3.2.4 Decision guidelines. Digital deliverable options for engineering drawings are not mutually exclusive. There will often be cases when several options will be combined for specific deliverables during a weapon system acquisition. 50.3.2.4.1 Intended data use. To help evaluate the various option combinations, the following guidelines are provided: a. Select raster image files for archiving and print-on- | demand requirements. | b. Select IGES data files for subsequent input to | government or industry CAD systems or to CIM systems | for manufacture of spares. | 50.3.2.4.2 Life cycle phases. To help evaluate the various option combinations, the following guidelines are provided: a. Select raster image files for early phases with low | volumes or frequent anticipated design changes, except | when the drawings submitted for design approval are to | undergo data processing analysis by the government. | b. Select raster image files in later phases if early | phase engineering drawings were paper-based. | c. Select IGES data files in later phases if the data are | to be input to CAD/CIM systems for modification or | spares manufacture. | 50.3.2.4.3 Delivery cost. To help evaluate the various option combinations, the following guideline is provided: Select magnetic tape for delivery of large volumes of engineering drawing data. Consider optical disk where | numerous copies of data are required and where the cost of | producing a master optical disk can be recovered through | 95 MIL-HDBK-59A APPENDIX B production of relatively inexpensive duplicates. | 50.3.2.4.4 Available technology. The following guideline applies: Select IGES data files if the engineering drawings were created on contractor CAD systems. 50.3.2.5 Contract implementation for digital data. The prior discussion of nodes on the Decision Template for Engineering Drawings indicated that there were two basic, yet non-exclusive, digital deliverable alternatives, as listed in Table V. | TABLE V. Summary of engineering drawing forms and standards. +----------------------------------------------------------------+ | Deliverable and Preferred Delivery Implement With | | Form Mode | |================================================================| | 1. Raster Image Magnetic Tape/ MIL-R-28002 ref. by | | File Optical Disk MIL-STD-1840 | | | | 2. CAD Data File Magnetic Tape/ MIL-R-28000 ref. by | | Optical Disk MIL-STD-1840 | +----------------------------------------------------------------+ 50.3.3 Product specifications and book form drawings. 50.3.3.1 Scope. Product specifications and book form drawings provide information such as material content, manufacturing and treatment processes, inspection and testing procedures, performance requirements, etc, needed for the acquisition of the drawing item. This information is an essential element of the product definition data set. It is characterized by a mix of approximately equal amounts of graphics and supporting narrative text. Specifications and book form drawings applicable to an item are referenced on the engineering drawing of that item. Additionally, a referenced specification or book form drawing may itself reference related specifications and book form drawings, creating a hierarchy of referenced information, all of which are required to fully describe the item. 50.3.3.2 Purpose. This section identifies the options for delivery of product specifications and book form drawings. The options selected for delivery of specifications and book form drawings are not necessarily the same as for engineering drawings. However, these information products are usually created, processed, and used in conjunction with one another. Consequently, when selecting the delivery option for | specifications and book form drawings, the delivery option for 96 MIL-HDBK-59A APPENDIX B the engineering drawings should be taken into consideration for technical data package (TDP) consistency. 50.3.3.3 Decision option discussion. Figure 6 shows the Master Decision Template for Acquisition of Digital Deliverables as applied to the specifications and book form drawing portion of a TDP. The alternatives presented, while not exclusive, must be considered and applied in context of the complete TDP and not the individual elements of a TDP. FIGURE 6. Decision template for product specifications and book form drawings. 50.3.3.3.1 Deliverable options - decision #1. The | specifications and book form drawings portion of the TDP can be | delivered as documents, processable data files, or interactive | access through CITIS to engineering design data bases containing | product specifications and book form drawings. The document | deliverable option offers the least flexibility, even when 97 MIL-HDBK-59A APPENDIX B provided in digital form. Documents are static, formatted presentations of information which can only be archived, viewed, and printed after receipt. Processable data files, on the other hand, offer greater capabilities; these files can be updated or transformed into many different document types. Delivery of specifications and book form drawings as processable text and CAD data files is both preferable and technically feasible. Source data can be created by electronic publishing systems (text) and CAD systems (graphics). However, the government data processing | infrastructure to permit acceptance and utilization of the | information in this form may not yet be available to many | acquisition programs. Therefore, the deliverable option for the | specifications and book form drawings portion of the TDP may be | effectively limited to the document category at present. | 50.3.3.3.2 Form options - decision #2. For documents, the options are either hard copy (paper or aperture cards), or digital raster images. While the hard copy option includes paper, the usual procedure is to deliver documents in the same aperture card form as for engineering drawings. The digital option is limited to raster image data because the PDL alternative has not been developed for specifications and book form drawings as it has been for technical manuals. As shown in Figure 6, certain types of processable data files are technically feasible, although not yet available because of receiving system limitations. When implemented, these options will include delivery of product specifications and book form drawings as processable text and graphics files, and ultimately integrated data files containing both text and graphics. Delivery of a combination of raster image text and CAD data files is also technically feasible. However, this imposes an additional layer of processing complexity on the sending system, and is not considered a practical alternative. 50.3.3.3.3 Specifications and standards option - decision #3. Since the processable data file option cannot currently be supported by DoD receiving systems, the relevant standards for that option will not be discussed, although they are listed in Figure 6. (See the discussion of specifications and standards for technical manuals and engineering drawings for additional information.) For deliverable documents, aperture cards are the predominant medium for capturing hard copy images of the specifications and book form drawings portion of a TDP. Specifications and standards governing hard copy preparation are DOD-STD-100, MIL-T-31000, MIL-STD-804, MIL-D-5480, MIL-M-38761, MIL-D-8510 and MIL-M-9868. MIL-R-28002 governs delivery of raster image files; the default form is Type I (untiled raster), with Type II (tiled raster) available to meet specific contract requirements. It is extremely unlikely that program needs would 98 MIL-HDBK-59A APPENDIX B dictate a different raster type selection for specifications and book form drawings than is made for engineering drawings. 50.3.3.3.4 Digital delivery mode options - decision #4. The delivery mode for specifications and book form drawings as documents (raster image files) may be either physical media or telecommunications. However, because of cost considerations, the delivery of raster image files using telecommunications bulk transfer conventions is not recommended. Of the physical media options shown at decision #4, magnetic tape is currently the preferred alternative. As with engineering drawings, optical disk provides a desirable future delivery mode option, although it is not yet widely available or standardized. See Appendix D of this handbook for the applicable tape media standards. 50.3.3.3.5 Digital deliverable summary. In general, the evaluation and selection of the options at each decision node of the specifications and book form drawings decision template must be aligned to the capabilities of the automated engineering data repository systems of the using Military Department. Selections should be consistent with those made for engineering drawings unless there is a specific reason for making different choices. 50.3.3.4 Decision guidelines. In general, the options selected for delivery of specifications and book form drawings in digital form are closely tied to the options selected for the associated engineering drawings in the TDP. As with the drawings, it is likely that no single option may apply to all specifications and book form drawings data. Finally, the delivery options selected for the specifications and book form drawings portion of the TDP must be compatible with the receiving system capabilities. The following guidelines are provided to assist in the option selection process. 50.3.3.4.1 Intended data use. The following general guideline is provided: Select raster image files for archiving and print on demand requirements. 50.3.3.4.2 Delivery cost. The following general guideline is provided: Select magnetic tape delivery for delivery of large volumes of specifications and book form drawings or, where multiple | copies are required, consider WORM or CD-ROM delivery. | 99 MIL-HDBK-59A APPENDIX B 50.3.3.4.3 Available technology. The following general guideline is provided: Select raster image files until destination system technology allows delivery of specifications and book form drawings as processable data files. 50.3.4 Electrical/electronic item product data. | 50.3.4.1 Deliverable Options - decision #1 (See Figure 7). | Technical information describing electrical/electronic product | items falls into two distinctly different delivery forms: | | a. DRAWING IMAGES - hard copy engineering drawings or | digital images of drawings. | | b. PROCESSABLE DATA FILES - computer interpretable | digital forms. | | In weapon system development contracts, digital delivery of | processable data files is preferred and should be considered the | standard form of communication of product data between the | contractor and the program office. Deviations from this norm | should be acceptable only: on programs in which a substantial | base of product data in drawing image form already exists (for | example, the incorporation of existing government furnished | equipment into a development program); for specific unusual items | of product data which can not be communicated by means of the | current set of product data file standards; or to communicate a | specific topic of engineering discussion between the program | office and contractor. Digital page image transmission of | drawings is preferred. Hard copy transfer is permissible only in | isolated cases involving limited amounts of data. Media used to | transmit digital drawings and processable data files shall be | marked in accordance with the current release of MIL-STD-1840 and | consistent with requirements as referenced in section 50.3.2.3.4. | | 50.3.4.2 Form options - decision #2. | | a. Drawing Images. The form decisions for delivery of | technical data describing electronic items parallel the | decisions for engineering drawings in general: hard | copy or raster image files. The discussion in section | 50.3.2.3.2.1 applies. | | b. Processable data files. In many cases, processable data | files parallel the information that would be delivered | in drawing form as indicated in the discussion that | follows in section 50.3.4.4. Processable data files | 100 MIL-HDBK-59A APPENDIX B have the advantages of more accurate representation of | product data, more compact forms of transmission, | methods of organization of the data for more immediate | availability to specific logistics engineering tasks | and compatibility with computer simulation and analysis | methods. Additionally, processable data files offer | methods of representation of novel types of product | information unavailable in drawing form, thus enhancing | logistics activities. The decision to be made at this | level is between a CAD data file and product data file. | CAD data files consist of electronic representations of | engineering drawings, such as schematic diagrams. | Product data files are more compatible in linking | computer-aided engineering and support processes and | thus are preferred. | | | FIGURE 7. Decision template for electrical/electronic items | | | 101 MIL-HDBK-59A APPENDIX B 50.3.4.3 Specifications and standards option - decision #3. | | a. Drawing Images. DOD-STD-100 and MIL-T-31000 apply to | drawing images whether delivered in hard copy or | digital form. MIL-R-28002 (Raster) is applicable to | conversion of existing hard copy formats to digital | form. | | b. CAD Data Files. The Class II subset of MIL-D-28000 | (IGES) and MIL-D-28003 (CGM) apply as discussed in | section 50.3.2.3.2.2. | | c. Product Data Files. The requirements of MIL-STD-1840 | and product data standards referenced therein apply to | the delivery of technical information in the form of | processable data files. As shown in Figure 7, the | standards and specifications selected will be | determined by the type of electronic item data | required. Standards and specifications are applied to | the program in the form of six distinct data packages | that reflect different classes of data which are | generated at various levels of design and phases of | development. The following sections provide guidance on | the application of these data packages to the weapon | system program. | | 50.3.4.4 Processable Data File Data Package Descriptions. The | six data packages referenced in this section refer to the | definitions of electronic product information elements that will | be included in a future revision to MIL-STD-1840. | | 50.3.4.4.1 Common Descriptive Data Elements Data Package. | Common data elements are those that represent the overview | (functional or topological) description of the item. They are | the processable data file equivalents of the following types of | engineering drawings described in DOD-STD-100: Reference | designations (102.2.1); Electrical and electronics diagrams | (103.1); Schematic diagram (201.7.1); Connection or wiring | diagram (201.7.2); Interconnection diagram (201.7.3); Single-line | diagram (201.7.4); Wiring diagram (201.9.2); Wiring harness | drawing (201.9.5); Parts list(601.1); Data list (601.2); and | Index list (601.3). The following information elements are | included in this data package: | | a. Functional partitioning definition. | | b. Symbol definition. | | c. Symbol definition. | 102 MIL-HDBK-59A APPENDIX B d. Signal definition. | | e. Port definition. | | f. Parts list. | | g. Interconnection list. | | h. Reference designators. | | Their purpose is to convey a high level understanding of the | system, box, printed wiring assembly, or component, including: | functional(partitioning) design, parts list, and interconnections | between major functional elements. As processable data files, | they are more flexible than drawing images, allowing a unified | "multi-level" description(for example, a schematic description | which extends through all levels of equipment integration without | recourse to a hierarchy of drawings). Common data elements are | delivered either as an independent data package or as a subset of | one of the other data packages. | | 50.3.4.4.2 Digital Electronic Product Item Functional Design | Description Data Package. This deliverable describes the abstract | or functional performance of the digital electronic product item | without reference to detailed physical implementation. It | replaces, while expanding upon, the Logic Diagram Drawing | referenced in DOD-STD-100. Its purpose is to provide a | comprehensive adequate description of digital electronic products | (at the integrated circuit or digital printed circuit board | assembly level) for: design review by the program office; | procurement of functionally equivalent parts; test program | development; and a variety of other logistics activities. Higher | levels of digital system integration (box or system) are | generally described by their schematic diagram or network listing | of interconnection between parts or assemblies (communicated by | the common data elements document type), accompanied by | functional design product description documents for the | assemblies or parts, although an entirely digital box may be | preliminarily described by a behavioral description. This data | package consists of the following data elements: | | a. Common product description elements. | | b. Behavioral description of digital electronics to | consist of: Algorithmic Description; Quantitative | Performance (Behavioral); Operating Range; Behavioral | Simulation Data, (including models). | | | 103 MIL-HDBK-59A APPENDIX B c. Logical description of digital electronics to consist | of: Logical Structural Description; Logic Simulation | Data, Including Models. | | d. Timing description (including rise, fall, delay and | propagation times). | | e. Test vectors. | | 50.3.4.4.3 Electrical/Electronic Product Item Circuit | Performance Description Data Package. This data package is | analogous to the digital functional design description data | package but applied to analog and microwave products. It | describes detailed internal circuit design and performance of | components and printed wiring assemblies and end to end external | (black box) performance characterization of higher levels of | system integration. Higher levels of analog system integration | (box or system) are generally described by their schematic | diagram or network listing of interconnection between parts or | assemblies, accompanied by external performance description of | the overall system and circuit performance description of the | parts or assemblies. The purpose of the data package is to | provide an adequate description of analog and microwave | electronic products (at the discrete or integrated circuit | component or printed circuit board assembly level) for: design | review by the program office; procurement of functionally | equivalent parts; test program development; and a variety of | other logistics activities. It includes the following data | elements: | | a. Common data element. | | b. Quantitative Performance Data to consist of : Gain | Charts, Performance Plots (e.g., V-I and Frequency), | and Operational Range Data. | | c. Timing Description (including rise and fall times). | | d. Circuit Simulation Data (including models). | | 50.3.4.4.4 Electrical/Electronic Product Item Manufacturing Data | Package. This data package consists of data elements that | support or document the production of the item. It constitutes | the technical data package in processable digital form that would | be used to support procurement (either as spares or on a second | source basis) of identical equivalents (build to print) of the | product item. In addition to other technical information, it | provides, in processable data file format, the equivalent to the | following drawing types described in DOD-STD-100: Printed wiring | 104 MIL-HDBK-59A APPENDIX B diagrams (103.3); Printed board description in digital form | (103.3.1); Assembly drawing (201.3); Numerical control drawing | (201.9.3); Printed wiring master drawing (201.9.9); Printed | wiring master (stable base artwork) pattern drawing (201.9.8); | and Parts list (601.1). It consists of the following data | elements. | | a. Common data elements. | | b. Interface control & limit. | | c. Environmental test parameters. | | d. Machine tooling description (including NC data and | pattern geometry) where applicable. | | e. Assembly drawing and notes. | | f. Physical design rules. | | g. Dimensions/Tolerances. | | h. Material Properties and construction notes. | | i. Assembly specification. | | j. Test and Burn-In Requirements. | | 50.3.4.4.5 Electrical/Electronic Product Item Documentation Data | Package. This data package consists of information elements that | provide additional documentation of the electric/electronic item | not contained in the other data packages for the purposes of | installation, testing, and logistics support. In addition to | other technical information, it provides, in processable data | file format, the equivalent to the following drawing types | described in DOD-STD-100: Control drawing (201.4); Installation | drawing (201.5); and Cable assembly drawing (201.9.6). It | consists of the following data elements: | | a. Detailed package drawings. | | b. Form factor description. | | c. Fixturing drawings. | | d. Cabling and conductors. | | e. Shipping container drawings. | | 105 MIL-HDBK-59A APPENDIX B 50.3.4.4.6 Electrical/Electronic Product Item General | Specification Description Data Package. This data package | consists of general specification product data: | | a. General description. | | b. Quality level. | | c. Safety information. | | 50.3.4.5 Application Guidance. The following guidance is | intended to be applied, as tailored to the requirements of the | individual program, to delivery of processable data file | packages. | | 50.3.4.5.1 Common Descriptive Data Elements Data Package. In | early phases of the program (up through preliminary design | review), common data elements will be the principal deliverable | in place of DOD-STD-100 format drawings. At the earliest program | phase, the common data elements type is appropriate for the | transfer of functional block diagram or functional partitioning | information in either direction between the contractor and the | program office. In program reviews prior to critical design | review, it is appropriate for transmission of basic design | information equivalent in use to the schematic diagram and parts | list. It is also appropriate in later program phases for the | transfer of specific detailed information, such as a wirelist, in | addition to other data packages. | | Where common data elements (see 50.3.4.4.1) are delivered as part | of another data package, they shall be delivered in the same | format as the rest of the document. When required as a stand- | alone deliverable, the common data elements shall be delivered in | EDIF format. | | 50.3.4.5.2 Digital Electronic Product Item Functional Design | Description Data Package. The digital electronic product item | functional design data package serves to communicate a wider | range of product description information than the common | descriptive document type and would normally be initially | delivered in conjunction with the Preliminary Design Review to be | updated at Critical Design Review. Another delivery (to take | place at the end of full scale development) would support | development of test programs and other logistics activities. An | additional delivery (to take place before full rate production) | is required for documentation of all digital electronic | components or assemblies for which re-procurement or resupply | might reasonably be expected. Specifically, this deliverable | should apply to: Commercially Available Integrated Circuits | 106 MIL-HDBK-59A APPENDIX B (behavior, timing, and test vectors), Application Specific | Integrated Circuits (behavior, structure, timing, and test | vectors), and all re-procurable digital printed wiring assemblies | (behavior, and external timing). | | The information elements listed above (behavior, structure, | timing, and test vectors) shall be delivered as independent | description; i.e., the timing description shall not be embedded | with either the logical or behavioral description. Unless | otherwise specified by the program office, this document shall be | delivered in VHDL format. Prior to specifying an alternative | format, the program office shall ensure that all repositories and | logistic support activities are fully capable of supporting the | alternative. | | 50.3.4.5.3 Electrical/Electronic Product Item Circuit | Performance Description Data Package. This data package serves | to communicate a wider range of product description information | than the common descriptive document type and would normally be | initially delivered in conjunction with the Preliminary Design | Review to be updated at Critical Design Review. Another delivery | (to take place at the end of full scale development) would | support logistic development activities, such as test program | development, and should be conducted to a sufficient level of | detail to support the required logistic activity. An additional | delivery (to take place prior to full rate production) is | required for documentation of all analog electronic components or | assemblies for which re-procurement or resupply might reasonably | be expected. Specifically, this deliverable should apply to: | End-to-End Performance Description of Systems, Boxes, and | Assemblies (preliminary and Critical Design Review); Discrete and | Integrated Commercial Components; Analog Application Specific | Integrated Circuits; and all re-procurable analog printed wiring | assemblies. | | Unless otherwise specified by the program office, this document | shall be delivered in EDIF format. Prior to specifying an | alternative format, the program office shall ensure that all | repositories and logistics support activities are fully capable | of supporting the alternative. | | 50.3.4.5.4 Electrical/Electronic Product Item Manufacturing Data | Package. Delivery of this information should be structured, as | needed, to support current or anticipated future production needs | of the program. Normally it would be delivered at the end of | full scale development or early production to be updated before | initiation of full rate production. The program office should | set requirements for delivery of this package based on projected | usage of the technical data contained therein to support re- | 107 MIL-HDBK-59A APPENDIX B procurement needs. | | Unless otherwise specified by the program office, this document | type shall be delivered in accordance with the following: | | a. Integrated Circuit Manufacturing Data --- EDIF. | | b. Printed Circuit Board Manufacturing Data --- IPC. | | c. Larger Assemblies and Configuration Items --- | MIL-D-28000, Class II. | | Prior to specifying an alternative format, the program office | shall ensure that all repositories and logistics support | activities are fully capable of supporting the alternative. | | 50.3.4.5.5 Electrical/Electronic Product Item Documentation Data | Package. This document type is appropriate for delivery at | various times throughout the program for the purpose of | describing in general or in detail the physical characteristics | of the product item. In addition, this document type will serve | to transmit, from a government repository to defense contractors, | standard package types, such as standard chip carriers or | standard hardware module configurations. | | Unless otherwise specified by the program office, this data shall | be delivered in MIL-D-28000, Class II. | | 50.3.4.5.6 Electrical/Electronic Product Item General | Specification Description Data Package. Unless other specified | by the program office, this document type shall be delivered in | accordance with the following: | | a. Integrated Circuit Data --- EDIF. | | b. Printed Circuit Board Data --- IPC. | | c. Larger Assemblies and Configuration Items --- | MIL-D-28000, Class II. | | 50.3.4.5.7 Level of Equipment Integration Definitions: The | following definitions should be used when developing the | requirements for a specific electrical/electronic item product | data package: | | a. System: A functionally complete assembly of | components, boards, and boxes. Usually implements a | complex analog, digital, or mixed task. Examples | 108 MIL-HDBK-59A APPENDIX B include general-purpose computer system, including | memory disk, and other I/O subsystems, a complete radar | system, or the entire electronic and electro-mechanical | system an aircraft. | | b. Box: An assembly of one or more boards to implement a | complex function. Includes back-plane or buss-oriented | assemblies, as well as direct-connect assemblies of | boards or substrates. Examples are the CPU of a | computer and front-end receiver of a radar system. | | c. Assembly: An assembly of components on board or | substrate. Examples include single, double, and multi- | layer board, ceramic, polyamide, silicon and other | substrate. | | d. Component: Items that are usually packaged as an | indivisible unit, to be assembled on a board or | substrate. Examples include IC's, resistors, | capacitors, inductors, transformers, discrete | transistors, DIP switches, fuses, and encapsulated | relays. | 50.3.5 Other TDP components (RESERVED). (This section will provide a decision template and supporting rationale for the acquisition in digital form of other elements of a technical data package. The CALS Industry Working Groups are defining those elements and the results will appear in a future update to this handbook.) 50.4 Acquisition of logistic support analysis records (LSAR). 50.4.1 Scope. This section addresses the acquisition alternatives of LSAR data. Logistic Support Analysis (LSA) builds upon data from related systems engineering and design analyses, and produces a consolidated and integrated set of logistics-related technical data. The resulting Logistic Support Analysis Record (LSAR) is a logically integrated data base consisting of both the engineering source data upon which analysis tasks are based, and the analysis results. With the exception of very small programs, documentation of the LSAR is accomplished using automated LSAR systems. MIL-STD-1388-2 defines the format and content of the LSAR and the structure of various standard reports that allow delivery of the data in digital form. It also defines LSAR system processing requirements and encourages additional LSAR system development. 109 MIL-HDBK-59A APPENDIX B 50.4.1.1 LSAR data elements. MIL-STD-1388-2 defines the total set of data elements that could make up an LSAR data base. The acquisition manager must tailor application of the standard to weapon system program requirements by selecting the subset of data elements actually required. This is done by incorporating in the contract DD Forms 1949-1 and 1949-2 listing the specific LSAR data that the contractor must generate and provide (through access or delivery) to the government. Some data elements (such as LSA control numbers) are required because they are keys to the data base organization. However, few weapon system programs require all LSAR data elements. 50.4.1.2 Joint service LSAR data system. A baseline LSAR system, the Joint Service LSAR Automated Data Processing System, | has been developed as one alternative for LSA automation. This | batch mode, flat file system is capable of satisfying the | requirements of MIL-STD-1388-2A, but it lacks many desirable | features and capabilities afforded by current technology. Many | contractors have augmented the joint service system by adding | front-end software to improve data entry efficiency. Others have | used data base management software to make the data accessible to | both on-line inquiries and various LSA software tools. Finally, | some contractors have linked software tools for other | engineering, design, and Integrated Logistic Support (ILS) | functions to the LSAR to use or update LSAR data. MIL-STD-1388- | 2B (DRAFT) was released for coordination and review by DoD. This | revised standard provides new relational data base tables that | replace/supersede the LSAR Master Files (Flat Files) used in MIL- | STD-1388-2A. The new standard also added 83 new data elements to | increase its utility. Some of the major changes from MIL-STD- | 1388-2A are: | | 1. Requirement for data to be delivered in relational | table formats. | | 2. Elimination of data input records and data elements | associated with card formats. | | 3. Elimination of non-product oriented output summaries. | (Tailored summaries can be developed using the | relational tables). | | Unlike MIL-STD-1388-2A, a Joint Service LSAR ADP system will not | be available for distribution. It is expected that independently | developed relational LSAR systems will be developed to fill the | void. These LSAR software systems must be validated against the | requirements set forth in MIL-STD-1388-2B. Also, because no | Joint Service LSAR ADP system will be available for distribution, | all independently developed systems complying with 1388-2B must | 110 MIL-HDBK-59A APPENDIX B provide full functional capability (Type III system) and shall be | validated as such. Additionally - | | 1. All current MIL-STD-1388-2A contracts and software will | continue to be supported. | | 2. Automated conversion routines will be developed to | allow transition from -2A files to -2B relational | files. | | 3. Additional functional area product requirements will be | incorporated as standardization is achieved. | | 4. A companion document with data model and business rules | will be published concurrent with MIL-STD-1388-2B. | | The use of a relational database management system and tables | offers many benefits to the acquisition manager. The relational | tables will allow for earlier changes to data base structure, | LSAR data can be shared with other functional areas, and one-time | storage of data elements improves quality and consistency of | products. The tables also allow ad hoc report generation, | tailored to the users needs, and a more practical method for on- | line access. | 50.4.1.3 Flexibility of the LSAR. Because of the range of data that can be documented in an LSAR, the LSAR is able to satisfy the data requirements of a number of the deliverables commonly appearing on a Contract Data Requirements List (CDRL), such as Provisioning Lists and Failure Modes, Effects, and Criticality Analysis reports. When these deliverables are submitted to the government as processable data files, or when direct access to the data base is provided, improvements in data accuracy and integrity usually result. Since the LSAR is already a logically integrated data base, it invites the use of other software tools and linkage with related engineering data bases. Furthermore, cost and time savings in data review or receipt of deliverables can also be achieved. During the initial acquisition contract, the most cost effective means of LSAR data access or delivery should be evaluated to enable the contractor to offer as part of the subsequent phase proposal one or more digital means of data delivery or access. 50.4.1.4 Relationship of standards for LSAR to other CALS stan- dards. Two functional standards govern LSA and the LSAR. MIL- STD-1388-1 defines the LSA process, as a result of which LSA data is created. MIL-STD-1388-2 defines the requirements for the LSAR, through which much of that data is assembled, managed, and reported. MIL-STD-1388-2 is also a technical standard for 111 MIL-HDBK-59A APPENDIX B delivery of LSAR data in digital form. Because it provides data | interchange and tape formatting requirements, it is unnecessary | (and incorrect) to use MIL-STD-1840 to define requirements for delivery of LSAR data in digital form. Future revisions might separate MIL-STD-1388-2's functional standard role from its technical standard role, if such a separation appeared to serve a practical purpose. At this time, it does not appear that this would be the case. 50.4.2 Decision option discussion. The master Decision Template for Acquisition of Digital Deliverables as applied to the LSAR is displayed in Figure 8. | FIGURE 8. Decision template for logistic support analysis records (LSAR). 50.4.2.1 Deliverable options - decision #1. LSAR data can be delivered as LSAR reports, LSAR data files, or through interactive access via CITIS to a contractor LSA data base. All | 112 MIL-HDBK-59A APPENDIX B three options either encourage or require a contractor automated LSAR. The requirements for LSAR final deliverables will likely be a combination of at least two of these options. 50.4.2.1.1 Deliverable options - decision #1 (for LSAR reports). The LSAR reports option includes the reports identified in Appendix B of MIL-STD-1388-2, plus any contractually-required, project-unique reports that can be produced using LSAR data. Most reports allow refinement or focus for a specific user by tailoring or reformatting. Many of the reports were designed as analysis and data review tools and are not intended to be deliverable products. LSAR reports are static presentations of LSAR data and cannot be updated or processed further after delivery. They offer the least flexibility for LSAR data use. Therefore, requiring LSAR reports as a deliverable option is appropriate only for one-time deliveries or when no further processing capability is available. 50.4.2.1.2 Deliverable options - decision #1 (for LSAR data files). LSAR data files, the second option, includes the three LSAR master files defined in MIL-STD-1388-2, and other LSAR data files that require processing after delivery (such as input files for Provisioning, Defense Logistics Services Center (DLSC) Screening, or Packaging Systems, among others). An internal data processing capability is required for each LSAR data file. Delivery of the LSAR master files provides the capability to subsequently produce any of the LSAR reports and other data files that the LSAR data base was designed to support, and provides historical baseline data for weapon system/equipment. Separate delivery of other LSAR data files places responsibility for their generation with the contractor rather than the government. Because of the flexibility provided by these processable data files, they can be used to satisfy both interim and final LSAR delivery requirements. Periodic delivery can reduce time spent for on-site data reviews by providing a vehicle for advanced review of the data. Final contract deliverables can be consolidated and reduced by internal processing of LSAR data files, in part or in total. 50.4.2.1.3 Deliverable options - decision #1 (for interactive access through CITIS). The third LSAR deliverable option is | interactive access through CITIS to a contractor's LSA data base. | Interactive access includes the ability to selectively retrieve, review and print, and process contractor LSA source data. Interactive access for faster government review of LSAR information represents more of a contractor service capability than a specific deliverable requirement. This capability makes the most current authorized data available to the government and eliminates the time required for preparation and submission of 113 MIL-HDBK-59A APPENDIX B deliverable products. It can also significantly reduce the time requirement for on-site reviews, while supporting internal analyses and planning that requires up-to-date supportability information. Interactive access provides the greatest flexibility for using LSAR data, either by utilizing the contractor's automated LSAR capabilities or by electronically transferring the data for further internal processing. Since interactive access can support interim and final delivery of both LSAR reports and data files, it may entirely eliminate the need to bring the LSAR data in-house. (However, it is advisable to have LSAR master files delivered at contract completion.) The interactive access service can be very effective for satisfying LSAR deliverable requirements during the early life cycle phases when the volume of LSAR is low. In latter phases, interactive access may be more appropriate as a contract compliance, data review, and internal analysis tool rather than for bulk transfers of complete LSAR master or other data files. 50.4.2.1.4 Requirement for automated LSAR. Regardless of which deliverable option is selected, statement of work (SOW) language | requiring the contractor to establish an automated LSAR capability should be included in the LSA Program SOW. (See 50.4.4 for sample SOW's.) 50.4.2.1.5 Use of multiple LSAR data sets. Logistic support analysis is a dynamic, iterative process requiring real-time interaction between the design, engineering analysis and product support planning functions. By this means, logistics considera- tions are made an inherent part of the design process, not an after-the-fact consequence of design decisions that excluded support requirements. The requiring activity (the government) must identify what LSAR data is required, and the performing activity (the contractor) must decide how best to structure the CITIS in which that LSAR data is processed, stored, and made available to users while maintaining appropriate data protection and data integrity. These decisions must balance the requirement for continuous, real-time update of LSAR data that documents LSA tasks already performed and supports LSA tasks underway or yet to be performed, with the requirement to periodically baseline technical information about the product being designed. Such baselines are needed to support configuration management of the product and its technical data, and to meet contractual requirements. Cost is an important consideration in this decision -- the additional costs of maintaining and reconciling multiple LSAR data sets, against the additional costs that result from losing configuration control of the product or of information about the product. The concept of working data, submitted data, and approved data is one solution to this problem, but it may not always be the optimum solution. Contract 114 MIL-HDBK-59A APPENDIX B SOW requirements such as those suggested here must be established with due consideration of these program management and cost considerations. 50.4.2.2 Form option - decision #2. Each of the three deliverable options for the LSAR provides one or more viable form options. 50.4.2.2.1 Form option - decision #2 (for LSAR reports). As shown at the top of Figure 8, LSAR reports can be delivered either as hard copy reports or as a report image file. Hard copy reports include both computer-generated LSAR reports (Appendix B of MIL-STD-1388-2) and program-unique LSAR reports. Report image files, the digital equivalent of these reports, require no further data processing and can be loaded, viewed, and printed using standard system utilities. Both options are a fixed presentation of the LSAR data and the applicable DID's must be selected for the desired reports. If the hard copy form is selected, the DID hard copy option should be noted. 50.4.2.2.2 Form option - decision #2 (for LSAR data files). The single available form option, alphanumeric files, is discussed above. The use of an integrated data file is a future option presently under development that will be addressed in the next update to this handbook. 50.4.2.2.3 Form option - decision #2 (for interactive access through CITIS). As shown at the bottom of Figure 8, interactive | access to a contractor's LSA data base through CITIS can take two | forms: predefined queries (CITIS Level 2) or ad-hoc queries | (CITIS Level 3). A predefined query is an established, fixed | format, with a controlled set of options, to extract information from LSA source data. All of the LSAR reports including program- unique reports that are contractually required, as well as LSAR master files and data files, can be described as predefined in this context. With the format, content, and options already having been specified, the user selects the file or report (usually via a menu choice) to be displayed. On the other hand, ad hoc queries allow the aggregation and presentation of a contractor's LSAR source data to be defined by a user during an on-line session with the contractor's system. Ad hoc query capabilities are governed by the specific technologies and software of the contractor's system, and their availability will be controlled by the contract or other form of agreement. As CALS data standards for LSAR are developed, this limitation may be altered, as reflected by the dashed line for data standards at the bottom of Figure 8. Until then, although the ad hoc query capability can be identified in the LSA SOW, it can only be defined by a contractor's proposal. Care should be exercised in 115 MIL-HDBK-59A APPENDIX B evaluating contractor proposals to ensure that the proposed ad hoc query capability will satisfy government requirements. 50.4.2.3 Specifications and standards - decision #3. There are no decision options on the standards for LSAR reports or LSAR master data files. These files are all alphanumeric tabular data files as specified in MIL-STD-1388-2. Since report image files can be generated by a sending system so easily, the technically feasible alternative of raster image data adds an additional level of data processing complexity, and is not a practical alternative. 50.4.2.4 Digital delivery mode options - decision #4. As shown at the right of Figure 8, there are two delivery mode options for LSAR report image files and for data files: physical media delivery or telecommunications transfer. Physical media consists | of data delivery on magnetic tape or optical disk. | Telecommunications involves the bulk electronic transfer of data files using a network that is compatible with a specific telecommunications standard (DDNs TCP/IP, or OSI's GOSIP FIPS 146), or a public, or contractor-specific non-standard telecommunications network. If interactive access is not chosen for interim reviews, the most cost effective option for final | delivery of LSAR reports and data files will normally be magnetic | tape or optical disk. When an interactive access capability will | be established, the cost and accessibility benefits of telecommunications versus physical media delivery modes must be evaluated. For physical media delivery, use existing or program- unique DIDs and indicate the tape delivery option. Reference the tape media standards contained in Appendix D of this handbook. For telecommunications delivery of LSAR report image files or data files, the reports or data files to be electronically transferred should be included in the LSA program SOW. 50.4.2.4.1 Interactive access through CITIS. For interactive | access through CITIS, the normal deliverable mode option is | telecommunications. Options for selection of a | telecommunications standard and delivery network are listed at the end of the telecommunications branch in Figure 8. The choice depends upon the volume of data to be transferred, as well as the technologies in place at contractor and government facilities. 50.4.2.4.2 Queries. If predefined queries (CITIS Level 2) are | selected as the access form, the LSAR reports and files and the | telecommunications standard should be included in the LSA program SOW. If ad hoc queries are chosen (CITIS Level 3), the LSA | program SOW must contain appropriate language without delineating specific report and data files. If both predefined and ad-hoc queries are required, include this in the LSA program SOW and 116 MIL-HDBK-59A APPENDIX B indicate the LSAR report and other files to be accessed. (See 50.4.4 for sample SOW paragraphs.) 50.4.3 Decision guidelines. Options for delivery of LSAR data in digital form are not mutually exclusive. There will often be cases when several options will be combined for specific deliverables during a weapon system acquisition. The decision criteria presented in this handbook focus on the best options, but must be evaluated against program-specific requirements and | must consider current and planned capabilities of the customer | and the contractor to utilize and produce data. The guidance | below applies the decision criteria to the various LSAR options. 50.4.3.1 Intended data use. The following guidelines apply: a. Select LSAR data files for consolidation of deliverables. b. Select LSAR data files if significant internal analysis of the data is anticipated. c. Select LSAR data files for input to automated government receiving systems. d. Select interactive access through CITIS with predefined | queries to review LSAR data. e. Select interactive access through CITIS with ad hoc | queries to support unique analysis or delivery needs. 50.4.3.2 Life cycle phases. The following guidelines apply: a. Select LSAR data files for later, high volume phases. b. Select interactive access through CITIS to replace | early phase LSAR deliverables. c. Select interactive access through CITIS to support LSAR | data reviews in all phases. d. Select LSAR hard copy reports for early phases if low volumes of data in the current or later phases do not justify the cost of additional automated processing. e. Select LSAR hard copy reports for nondevelopmental programs with limited service life data requirements. 117 MIL-HDBK-59A APPENDIX B 50.4.3.3 Delivery cost. The following guidelines apply: a. Select LSAR report image files if multiple report copies are required and the processing capabilities of government receiving system are limited. b. Select LSAR data files, in general, as the most cost effective option for all deliverables. c. Select interactive access through CITIS access to | minimize on-site review requirements. d. Select magnetic tape or optical disk for delivery of | high volumes of digital data. 50.4.3.4 Available technology. The following guidelines apply: a. Select LSAR hard copy reports or interactive access if no internal data processing system capabilities are available. b. Select LSAR report image files or interactive access through CITIS if only limited internal data processing | system capabilities are available. c. Select LSAR data files for full scale development or production phases if internal data processing capabili- ties are available or planned for that time. 50.4.4 Contract implementation for digital data. Automation and telecommunications technologies, while providing extended capabilities to industry and government, are altering the ways in which LSA and LSAR reporting and use are performed. The prior discussion of decision choices on the LSAR decision template indicated that there were six basic, yet non-exclusive, alterna- tives for delivery of digital data. These alternatives require that specific procedures be established for LSAR configuration management, interactive access controls, government review and feedback, and product delivery. The alternatives associated with telecommunications assume that an interactive access capability exists for LSAR report files. When existing functional standards are insufficient to describe the appropriate methods to contrac- tually invoke these alternatives, new SOW language must be provided. Each alternative has specific SOW phrases that should be included in the LSA program SOW. Sample SOWs are provided in | the following text to implement the alternatives as summarized in Table VI. 118 MIL-HDBK-59A APPENDIX B 50.4.4.1 Sample SOW language. The following sample SOWs describe the contractor technology capabilities required by the alternatives. These SOWs are cumulative based upon the combination of alternatives desired within the program. The SOWs | should be used until the publication of the CITIS Functional | Specification (MIL-F-CITIS). | a. SOW #1 is suggested for automated LSAR capability. | | The contractor shall establish and maintain a validated | LSAR automated data processing system capable of input, | storage, and retrieval of LSAR data in accordance with | MIL-STD-1388-2. The contractor may use an internally | developed and validated LSAR automated data processing | system, an independently developed and validated LSAR | automated data processing system, or the government | furnished Joint Service LSAR Automated Data Processing | System. The validated LSAR automated data processing | system shall comply with paragraph 4.2.2 of MIL-STD- | 1388-2 and shall be used for the preparation of LSAR | output reports as specified in the CDRL. | TABLE VI. Summary of LSAR forms and standards. +-----------------------------------------------------------------+ | Deliverable and | Preferred | Implement With | | Form | Mode | | |=================================================================| | 1. LSAR Report | Magnetic Tape/ | New SOW #1 | | Files | Optical Disk | | | | | | | | 2. LSAR Report | Telecommunications | New SOWs #1 and #2 | | | Files | | | | | | | | | | 3. LSAR and Master | Magnetic Tape/ | New SOW #1 | | | Data Files | Optical Disk | | | | | | | | | 4. LSAR and Master | Telecommunications | New SOWs #1 and #2 | | | Data Files | | | | | | | | | | 5. Interactive and | Telecommunications | New SOWs #1 and #2 | | | Predefined Query | | | | | | | | | | 6. Interactive Ad- | Telecommunications | New SOWs #1 and #2 | | | Hoc Query | | | +-----------------------------------------------------------------+ | b. SOW #2 is suggested for interactive access through | CITIS with predefined queries. | 119 MIL-HDBK-59A APPENDIX B The contractor shall establish and maintain automated sets of LSAR data for the management and control of the LSAR. As a minimum, the contractor shall maintain a set of LSAR working data for in-process review and a set of government approved LSAR data. The LSAR data contained in the working (in-process review) set shall be LSAR that has been subjected to internal contractor review procedures and frozen, pending government review and approval. The LSAR working data shall be updated in accordance with the schedule in the LSA plan regardless of the approval status of their content since the last update. Upon government approval, LSAR data contained in the working set shall be transferred to the government-approved LSAR data set. All government-directed changes resulting from the LSAR review process shall be incorporated prior to relocation of the data. The government-approved LSAR data shall be cumulative of all government-approved LSAR data. The contractor shall provide the government with interactive access (CITIS Level 2) to both the working (as negotiated) | and approved LSAR data sets. The contractor shall provide the means for controlling access capability. The interactive access capability shall include the ability to interrogate, retrieve, review, and print the following: 1. Predefined standard LSAR summaries using established standard LSAR report selection procedures contained in the applicable Data Item Descriptions. 2. Any of the following government specified reports: (SPECIFY CONTENT, FORMAT, AND SEQUENCE OF EACH REPORT) The software will provide the ability to save query results | and retrieved data as named files. Additionally, the | software will provide the capacity for terminal display of | query results or data files in 80 and/or 132 character | format, and will include the capability to print the results of the queries on a local printer at designated locations. The user shall have the capability to specify queries by data set. User options shall include generation of queries from the working data (as negotiated), the approved data or a combination of both. The contractor shall provide government with the interactive access capability ---------------. (SPECIFY PERIODS OF REQUIRED ACCESS, i.e.,. 0800-1600 EASTERN STANDARD TIME DAILY, 24 HOUR CONTINUOUS, ETC.) Government use of the access capability shall be limited to ----------------. (SPECIFY ACCESS USAGE REQUIREMENTS, i.e., IN CPU 120 MIL-HDBK-59A APPENDIX B MINUTES/MONTH, TOTAL CONNECT TIME, ETC.) Access shall be limited to the following locations: (SPECIFY LOCATIONS) The contractor shall establish telecommunications capability using one or more of the following methods and shall establish a means for ensuring completeness and accuracy of data transmissions. 1. Point-to-point dedicated lines, 2. A mutually acceptable commercial timesharing or packet switching network, 3. Telecommunications equipment and networks compatible with OSI using FIPS 146, 4. The Defense Data Network (DDN), or 5. Another mutually acceptable method as defined in the contractor's proposal. In addition, the contractor shall provide: 1. The hardware for each of the designated locations (if required). 2. Maintenance for contractor furnished equipment and software (if required). 3. Training for --- (SPECIFY NUMBER) operators at each designated location. 4. --- (SPECIFY NUMBER) set(s) of automated data processing system operator manuals and user documentation per location. c. SOW #3 suggested language for interactive access (CITIS | Level 3) with ad hoc queries. | | In addition to the predefined LSAR output reports, the | contractor shall establish the capability for on-line | ad hoc query (report generation). Ad hoc reporting | capabilities shall be defined by the contractor's LSAR | automated data processing system software and presented | in the LSA portion of the contractor proposal. As a | minimum, the ad hoc report generation shall be capable | of keying on and displaying the following LSAR data | elements: LSA Control Number (LCN), Alternate LSA | Control Number Code (ALC), Part Number, Item Name, Task | Frequency, Federal Supply Code for Manufacturers | 121 MIL-HDBK-59A APPENDIX B (FSCM), Quantity Per Assembly, Unit of Measure Price, | (ADD ADDITIONAL DATA ELEMENTS AS REQUIRED TO THIS | LIST). | 50.5 Acquisition of training products. 50.5.1 Scope. This section provides guidance in determining training products to be delivered to the government in digital form, and describes appropriate acquisition alternatives. Many but not all training products are suitable candidates for digital development, delivery, and application. Many training products contain a combination of textual narrative and illustrative graphic images presented in a formal, structured, page-oriented format, which allows use of the same technologies and CITIS capabilities as are used for preparation and delivery of technical manuals. The guidance in this section assumes that the Instructional Systems Development (ISD) process described in MIL- T-29053 and the ISD deliverables identified in MIL-STD-1379D (DRAFT) or similar service-specific functional standards will be used to determine the appropriate form and format of training products to be delivered. 50.5.1.1 Training products and media. Training products are used to train military personnel in the safe and effective operation and maintenance of weapon systems and equipment. They contain a composite of textual narrative and illustrative graphic images presented in a variety of media which are determined by program- specific training needs. Each of these products and media has particular attributes which make it an appropriate training solution to a particular set of training needs. Although training products can be developed in a variety of forms, they are all presented via a finite set of training media. Each of these training media could be contracted for and delivered in a standardized digital format with varying degrees of ease and usefulness. The media used to present instructional products can be grouped into the following media categories: 50.5.1.1.1 Instructor-based training. Instructor-based training includes any form of training which utilizes an instructor, monitor, resource person, lab assistant, etc. Most of the training products which support instructor-based training could easily be contracted for and delivered as digital data. These products include instructor lesson plans, paper-based supplementary products, student workbooks, copies of visual training aids, performance evaluation tools, and job aids. 50.5.1.1.2 Paper-based (page-oriented) training. The paper-based training category includes training that is conducted primarily by some form of paper-based material. Paper-based training 122 MIL-HDBK-59A APPENDIX B products are page-oriented products in that information is organized and presented via a page. Paper-based training usually includes the use of self-paced or instructor lead workbooks, tutorials, or job aids. Also included in paper-based training products are reference guides such as technical manuals and system documentation. (These are addressed separately in this handbook.) A significant percentage of all training products currently developed are paper-based. Paper-based products and training products could easily be contracted for and delivered as digital data in much the same way as technical manuals. 50.5.1.1.3 Computer-based training. Computer-based training refers to training which is delivered via computer. | Computer-based training includes tutorials, drill and practice, simulations, testing, and may also include embedded training. Computer-based training programs are already delivered in digital form to the government. However, they are currently delivered in a variety of formats and on a variety of magnetic media. 50.5.1.1.4 Video-based and audio-based training. Video media includes video tape or film training packages, interactive video- tape training, and interactive video disc training. Audio-based training includes cassette tape programs, instructional records, training extension course tapes, and audio-workbooks. Audio-based training is often supplemented by paper-based training such as job aids or workbooks and visual-based training products such as slides. Current technology would not allow for video-based training programs to easily be delivered in a digital format. Delivery of audio-based training programs in digital form is quite feasible. Whether or not it is cost effective and useful to require audio-based training programs to be delivered in digital format is undetermined. 50.5.1.2 Training products development. DoD has developed the ISD methodology as a standard approach for the development of all contractor produced training programs throughout the military. ISD is a highly structured methodology which calls for the development of standard interim products, such as reports and plans, and ongoing government review. This highly structured methodology lends itself to delivery of products in digital form for government review and approval before the contractor moves to the next step in the development process. For the purposes of simplicity, this appendix addresses deliverables set forth in MIL-STD-1379D (DRAFT). However, the guidance provided in this document also applies to other service-specific training development guidance documents. 50.5.1.2.1 Interim products. The standard interim products that result from the ISD methodology typically include paper-based, 123 MIL-HDBK-59A APPENDIX B page-oriented products such as training programs and training equipment plans; manpower, personnel, and training reports, personnel performance profile reports, media selection and syllabus reports; and course, module, and lesson objectives, etc. Additional products which may be developed in either paper-based or digital form include course, module, lesson flowcharts, tests, storyboards, and visual or video media shotsheets. The ISD methodology specifies that the government must review and approve each interim product before the contractor moves to the next step of the development process. 50.5.1.3 Data sources for training products. The Logistic Support Analysis Record (LSAR) consolidates logistics-oriented technical information in conjunction with data for the various engineering disciplines and Integrated Logistic Support elements to reduce redundancy, facilitate timely usage, and enhance consistency between data elements and disciplines. The quality and productivity of training product development is enhanced when the LSAR is used as a principal data source for this process. Integration of the data bases that produce LSAR task analysis (and other) data, technical manuals, and training materials will provide even greater benefits. 50.5.1.4 Coverage. This section only addresses the delivery in digital form of page-oriented training products. Requiring all training products to be delivered in a standard digital form would probably not be cost effective at this time. 50.5.2 Decision option discussion. Figure 9 shows the decision | template applied to page-oriented training product deliverables. Decisions regarding whether training products should be delivered in digital form and the specifications for that form should be consistent with decisions made for other contract deliverables such as technical manuals. The following sections describe the decisions to be made in determining the form and appropriate specifications for training product deliverables. 50.5.2.1 Deliverable options - decision #1. Training products | can be delivered as either composed documents, processable data | files, or interactive access through CITIS to integrated data | bases of training data. | 50.5.2.1.1 Deliverable options - decision #1 (for composed training product documents). The composed document deliverable option offers the least flexibility. It is a static, formatted presentation of the material which can only be archived, viewed, or printed after receipt. Documents can be delivered as either camera-ready hard copy, or as a digital print/display file. 124 MIL-HDBK-59A APPENDIX B FIGURE 9. Decision template for training products. 50.5.2.1.2 Deliverable options - decision #1 (for processable files). Processable training product data file deliverables offer more robust capabilities than document form deliverables. These files can be updated or transformed into many different document types. With the appropriate governmental receiving systems, processable files can support the development of summary guides, training aids, and eventual on-line distribution of selected portions of the data to trainees. Processable files are preferable because of their flexibility and maintainability; however the tools to permit acceptance and utilization of the information in this form are in various stages of development at this time. 50.5.2.2 Form options - decision #2. 50.5.2.2.1 Form options - decision #2 (for composed training pro- duct documents). The form for composed training product document delivery can be either a hard copy or a digital print/display file. The digital form of this deliverable consists of composed 125 MIL-HDBK-59A APPENDIX B page images of material. It offers greater advantages in storage, distribution, viewing, and printing than hard copy. It also provides slightly more flexibility than hard copy with respect to future data uses, although its format will be fixed and unyielding. It is a two-dimensional image of each page, offering no further updating or processing features beyond replication. When changes are made, however, they can be more easily distributed than paper-based changes. 50.5.2.2.2 Form options - decision #2 (for processable data files). At present, a processable file must comprise one set of files for textual or numeric data and separate files for graphics, i.e., illustrations and drawings. In the future, text and graphics files will be available as integrated data files with configuration management and positioning features. The technologies and standards to accomplish such integration and to allow joint processing or creation of the two data formats for concurrent presentation, however, are not yet sufficiently advanced. 50.5.2.3 Specifications and standards - decision #3. 50.5.2.3.1 Specifications and standards - decision #3 (for hard copy). Currently each deliverable form, with the exception of the processable files graphic file form, has one predetermined standard and specification. The hard copy form should be acquired in compliance with MIL-STD-1379D (DRAFT). 50.5.2.3.2 Specifications and standards - decision #3 (for print/display files). The digital form of the composed training product document, a print/display file, requires tailoring MIL- STD-1379D (DRAFT) by referencing the appropriate standards shown in Table VII. This data can also be delivered as raster page images, in accordance with MIL-R-28002. For most applications, the default Type I (untiled) format is applicable. Storage of page images in a Page Description Language (PDL) provides an intermediate form which is slightly easier to maintain. PDL files can be acquired using MIL-M-28001. However, these are not standardized, for no Standard Page Description Language (SPDL) exists yet. 50.5.2.3.3 Specifications and standards - decision #3 (for processable files). Processable training product files comprise separate text and graphics files. There is only one available text file standard, MIL-M-28001 (SGML), but users must require creation and delivery of appropriate document type definition and output specification support files, as well as the SGML-tagged source file. There are several standards available for graphics files. As with technical manuals, a mixed mode deliverable, 126 MIL-HDBK-59A APPENDIX B consisting of processable text in accordance with MIL-M-28001 and raster document image files in accordance with MIL-R-28002 is a viable option. Raster format is often an attractive, cost-effective alternative for converting existing paper-based drawings and illustrations into digital form. Because they offer more flexibility and utility, and may be created and used on a greater variety of computer systems, vector graphics are preferred for new weapon system acquisitions. Use of CGM is preferred, but IGES is allowed. MIL-D-28003 addresses CGM vector graphics data; based on program requirements for interim and final training product deliverables, the acquisition manager should choose between draft quality Level II and publication quality Level I CGM conforming metafiles. MIL-D-28000 addresses vector graphics in IGES format; the Class I technical illustration subset is most appropriate. 50.5.2.4 Digital delivery mode - decision #4. As shown on the decision template, physical media are currently the only delivery mode option for the digital delivery of document image files or processable files. While a telecommunications bulk transfer of these files may be possible, it is not currently a feasible option because of the large volume of data contained in these files, particularly the raster page image and raster graphics files. Magnetic tape and optical disk are the preferred physical | media options available for the delivery of print/display files | or processable files. For magnetic tape standards, reference | the tape media standards contained in Appendix D of this handbook. 50.5.3 Decision guidelines. Options for delivery of training products in digital form are not mutually exclusive. There will often be cases when several options will be combined for specific deliverables during a weapon system acquisition. The decision criteria presented in this handbook can be used to help make the decisions on the decision template. The following is guidance for applying the criteria to training products. 50.5.3.1 Intended data use. The following guidelines are provided: a. Select processable files if government update and | maintenance is anticipated for the future. | | b. Select processable files if the future creation of | specialized documents and aids is envisioned. | | c. Select raster image files if only an automated print- | on-demand capability is desired or available. | | 127 MIL-HDBK-59A APPENDIX B d. Select vector graphics files if update and maintenance | of illustrations and drawings is desired. | 50.5.3.2 Life cycle phases. The following guidelines are provided: a. Raster image or print/display files should be acquired | early in the life cycle of the program if most cost | effective. | | b. Processable training product files should be the | deliverable of choice when the government assumes the | responsibility for training manual update and | maintenance. | | c. Select static page-oriented documents if a program is | in a late phase and large amounts of data already exist | in paper form. | 50.5.3.3 Delivery cost. The following guideline is provided: Select magnetic tape or optical disk for delivery because of the high volumes of digital data required by training products. 50.5.3.4 Available technology. The following guidelines are provided: a. Options should be aligned to the automated publishing | systems/computer resources in the Military Department | receiving the deliverable. | | b. Select hard copy if no internal data processing system | capabilities are available or planned. | | c. Select raster print/display files if only minimal data | processing capabilities are available internally. | 50.5.4 Contract implementation for digital data. There are four basic, yet nonexclusive, alternatives for delivery of digital data. These are shown in Table VII. The existing functional standard is insufficient to contractually invoke these alternatives. Therefore, tailoring of MIL-STD-1379 is required. 50.5.4.1 Training functional standard. Following its publication, reference the tailored MIL-STD-1379D in Block 16 of the CDRL (DD Form 1423) to specify delivery of digital data in accordance with its requirements and MIL-STD-1840. Pending publication of MIL-STD-1379D (DRAFT), make its language part of 128 MIL-HDBK-59A APPENDIX B the statement of work. The physical media standards for magnetic tape delivery mode shown in Appendix D should also be specified. TABLE VII. Summary of training products forms and standards. +-----------------------------------------------------------------+ | Deliverable and Preferred Implement With | | Form Mode | |=================================================================| | 1. Training Magnetic Tape/ MIL-R-28002 or MIL- | | Product/ Print Optical Disk M-28001 (PDL only, | | Display and MIL-STD-1840 | | | | 2. Processable Text Magnetic Tape/ MIL-M-28001 and | | File Optical Disk MIL-STD-1840 | | | | 3. Processable Magnetic Tape/ MIL-D-28000 and | | Vector Graphics Optical Disk MIL-STD-1840 | | File - IGES | | | | 4. Processable Magnetic Tape/ MIL-D-28003 and | | Vector Graphics Optical Disk MIL-STD-1840 | | File - CGM | +-----------------------------------------------------------------+ 50.6 Acquisition of technical specifications and reports (RESERVED). (This section will provide a decision template and supporting rationale for the acquisition of technical specifications, reports, plans, and other contractual deliverables involving integrated text and graphics, e.g., those prepared in a desk top publishing environment). 50.7 Acquisition of maintenance information for interactive | presentation (RESERVED). | (This section will provide a decision template and supporting rationale for the acquisition of maintenance information for | interactive presentation, including Interactive Electronic | Technical Manuals.) | 50.8 Acquisition of integrated diagnostics (RESERVED). | (This section will provide a decision template and supporting | rationale for the acquisition of integrated diagnostics). | 129 MIL-HDBK-59A APPENDIX B THIS PAGE INTENTIONALLY LEFT BLANK 130