RFP_Attch_16_MIL-STD-3048C_Capability Task Ref.pdf

NOT MEASUREMENT

SENSITIVE

MIL-STD-3048C(USAF)

15 May 2023

SUPERSEDING

MIL-STD-3048B(USAF)

20 September 2018

DEPARTMENT OF DEFENSE

STANDARD PRACTICE

AIR FORCE BUSINESS RULES FOR

THE IMPLEMENTATION OF S1000D

AMSC 10403 AREA TMSS

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z Check the source to verify that this is the current version before use.

FOREWORD

1. This standard is approved for use by the Department of the Air Force and is available for use by all Departments and Agencies of the Department of Defense.

2. This revision includes multiple editorial and requirements changes. The major changes include but are not limited to the following:

a. Added Controlled Unclassified Information (CUI) requirements.

b. Added emergency border marking requirements.

c. Added Scalable Vector Graphics (SVG) file format to list of allowable formats.

d. Added clarification to several requirements such as use of Common Information Repositories (CIRs) and gender-neutral terms.

e. Relaxed requirement for mandatory coordination for new information code variants.

f. Added Commercial and Government Entity (CAGE) code to represent the Secretary of the US Air Force.

g. Limited footnotes to tabular data.

h. Relaxed requirement for mandatory titles on all levelled paragraphs for legacy data.

i. Added new appendix containing mandatory functionality requirements.

3. Comments, suggestions, or questions on this document should be addressed to AFLCMC/GBS Technical Data Section, 4170 Hebble Creek Road, Bldg. 280, Door 15, Area A, Wright-Patterson AFB, OH 45433-5653 or emailed to SGMLsupport@us.af.mil. Since contact information can change, you may want to verify the currency of this address information using the ASSIST Online database at https://assist.dla.mil.

MIL-STD-3048C(USAF)

ii Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z

Check the source to verify that this is the current version before use.

mailto:SGMLsupport@us.af.mil https://assist.dla.mil

CONTENTS

FOREWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

1 SCOPE

1.1 Scope

1.1.1 Application to S1000D

1.2 Organization of the technical content

1.2.1 JSBRs

1.2.2 Project business rule decision points

1.3 Digital data preparation and delivery

2 APPLICABLE DOCUMENTS

2.1 General

2.2 Government documents

2.2.1 Specifications, standards, and handbooks

2.2.2 Other Government documents, drawings, and publications

2.3 Non-Government publications

2.4 Order of precedence

3 DEFINITIONS

3.1 Acronyms used in this standard

3.2 Terms

3.2.1 Acquiring Activity

3.2.2 Applicability

3.2.3 Assembly

3.2.4 Business Rules EXchange (BREX)

3.2.5 Callout

3.2.6 Commercial and Government Entity (CAGE) Code

3.2.7 Expendability, Recoverability, Reparability Category

3.2.8 End Item Acronym Code (EIAC)

3.2.9 EXtensible Markup Language (XML)

3.2.10 Filtering

3.2.11 Functionality matrix

3.2.12 Hardness Critical Item (HCI)

3.2.13 Icon

3.2.14 Illustrated Parts Data (IPD)

3.2.15 Index number/Item number

3.2.16 Information set

3.2.17 Interactive Electronic Technical Manual (IETM)

3.2.18 Interactive Electronic Technical Publication (IETP)

3.2.19 International Organization for Standardization (ISO)

3.2.20 Legend

3.2.21 Maintenance level

3.2.22 Maintenance task

3.2.23 National Item Identification Number (NIIN)

3.2.24 Nomenclature

3.2.25 Product

3.2.26 Project

3.2.27 Reference designator

3.2.28 Revision

3.2.29 Source, Maintenance, and Recoverability (SMR) code

3.2.30 Special tools

3.2.31 Standard Numbering System (SNS)

3.2.32 Subassembly

3.2.33 Support Equipment (SE)

MIL-STD-3048C(USAF)

iii

3.2.34 Tailoring (business rules)

3.2.35 Technical Manual (TM)

3.2.36 Usable On Code (UOC)

3.2.37 Viewer

3.2.38 XML Schema

4 GENERAL REQUIREMENTS

4.1 General

4.1.1 Legacy projects

4.2 Business rules

4.3 Preparation of digital data for electronic delivery

4.4 Use of XML data elements for tagging technical data

4.4.1 Tagging consistency

4.4.2 Intelligent data

5 DETAILED REQUIREMENTS

5.1 S1000D Chapter 1.4 - Introduction to the specification - How to tailor for a specific project

5.1.1 USAF business rules

5.2 S1000D Chapter 1.5 - Introduction to the specification - Request for change

5.2.1 USAF business rules

5.3 S1000D Chapter 3.4 - Information generation - Zoning and access

5.3.1 USAF business rules

5.4 S1000D Chapter 3.5 - Information generation - Updating data modules

5.4.1 USAF business rules

5.5 S1000D Chapter 3.6 - Information generation - Security and data restrictions

5.5.1 USAF business rules

5.6 S1000D Chapter 3.7 - Information generation - Quality assurance

5.6.1 USAF business rules

5.7 S1000D Chapter 3.9.1 - Authoring - General writing rules

5.7.1 USAF business rules

5.8 S1000D Chapter 3.9.2.1 - Illustration rules and multimedia - Illustrations, General

5.8.1 USAF business rules

5.9 S1000D Chapter 3.9.2.3 - Illustration rules and multimedia - Use of color and photographs

5.9.1 USAF business rules

5.10 S1000D Chapter 3.9.2.4 - Illustration rules and multimedia - Multimedia, General

5.10.1 USAF business rules

5.11 S1000D Chapter 3.9.2.5 - Illustration rules and multimedia - Interactive 3D content

5.11.1 USAF business rules

5.12 S1000D Chapter 3.9.3 - Authoring - Warnings, cautions, and notes

5.12.1 USAF business rules

5.13 S1000D Chapter 3.9.4 - Authoring - Front matter

5.13.1 USAF business rules

5.14 S1000D Chapter 3.9.5.1 - Data modules - Identification and status section

5.14.1 USAF business rules

5.15 S1000D Chapter 3.9.5.1.1 - Identification and status section - Export control

5.15.1 USAF business rules

5.16 S1000D Chapter 3.9.5.2.1.1 - Common constructs - Change marking

5.16.1 USAF business rules

5.17 S1000D Chapter 3.9.5.2.1.2 - Common constructs - Referencing

5.17.1 USAF business rules

5.18 S1000D Chapter 3.9.5.2.1.4 - Common constructs - Caption groups

5.18.1 USAF business rules

5.19 S1000D Chapter 3.9.5.2.1.5 - Common constructs - Titles

5.19.1 USAF business rules

5.20 S1000D Chapter 3.9.5.2.1.6 - Common constructs - Tables

MIL-STD-3048C(USAF)

CONTENTS

iv

5.20.1 USAF business rules

5.21 S1000D Chapter 3.9.5.2.1.7 - Common constructs - Figures, multimedia and foldouts

5.21.1 USAF business rules

5.22 S1000D Chapter 3.9.5.2.1.9 - Common constructs - Preliminary requirements and requirements after job completion

5.22.1 USAF business rules

5.23 S1000D Chapter 3.9.5.2.1.10 - Common constructs - Text elements

5.23.1 USAF business rules

5.24 S1000D Chapter 3.9.5.2.1.11 - Common constructs - Controlled content

5.24.1 USAF business rules

5.25 S1000D Chapter 3.9.5.2.1.12 - Common constructs - Common information

5.25.1 USAF business rules

5.26 S1000D Chapter 3.9.5.2.3 - Content section - Procedural information

5.26.1 USAF business rules

5.27 S1000D Chapter 3.9.5.2.5 - Content section - Maintenance planning information

5.27.1 USAF business rules

5.28 S1000D Chapter 3.9.5.2.6 - Content section - Crew/Operator information

5.28.1 USAF business rules

5.29 S1000D Chapter 3.9.5.2.7 - Content section - Parts information

5.29.1 USAF business rules

5.30 S1000D Chapter 3.9.5.2.9 - Content section - Wiring data

5.30.1 USAF business rules

5.31 S1000D Chapter 3.9.5.2.10 - Content section - Process data module

5.31.1 USAF business rules

5.32 S1000D Chapter 3.9.5.2.11 - Content section - Common information repository

5.32.1 USAF business rules

5.33 S1000D Chapter 3.9.5.2.12 - Content section - Container data module

5.33.1 USAF business rules

5.34 S1000D Chapter 3.9.5.2.13 - Content section - Learning data module

5.34.1 USAF business rules

5.35 S1000D Chapter 3.9.5.2.16 - Content section - Front matter

5.35.1 USAF business rules

5.36 S1000D Chapter 3.9.5.3 - Data modules - Applicability

5.36.1 USAF business rules

5.37 S1000D Chapter 3.9.6.1 - Attributes - Project configurable values

5.37.1 USAF business rules

5.38 S1000D Chapter 4.2.1 - Common source database - Information objects

5.38.1 USAF business rules

5.39 S1000D Chapter 4.3.1 - Data module code - Model identification code

5.39.1 USAF business rules

5.40 S1000D Chapter 4.3.3 - Data module code - Standard numbering system

5.40.1 USAF business rules

5.41 S1000D Chapter 4.3.4 - Data module code - Disassembly code

5.41.1 USAF business rules

5.42 S1000D Chapter 4.3.6 - DMC - IC

5.42.1 USAF business rules

5.43 S1000D Chapter 4.4 - Information management - Information control number (ICN)

5.43.1 USAF business rules

5.44 S1000D Chapter 4.5 - Information management - Data management lists

5.44.1 USAF business rules

5.45 S1000D Chapter 4.6 - Information management - Comment

5.45.1 USAF business rules

5.46 S1000D Chapter 4.8 - Information management - Interchange of data modules

5.46.1 USAF business rules

5.47 S1000D Chapter 4.9.1 - Publication management - Publication module

MIL-STD-3048C(USAF)

CONTENTS

v

5.47.1 USAF business rules

5.48 S1000D Chapter 4.9.2 - Publication management - Coding publication modules

5.48.1 USAF business rules

5.49 S1000D Chapter 4.10 - Information management - Business rules exchange

5.49.1 USAF business rules

5.50 S1000D Chapter 4.10.2 - Business rules exchange - BREX data module

5.50.1 USAF business rules

5.51 S1000D Chapter 4.10.2.2 - BREX data module - Context related rules

5.51.1 USAF business rules

5.52 S1000D Chapter 4.12 - Information management - Multiple instances of CSDB objects

5.52.1 USAF business rules

5.53 S1000D Chapter 5 - Information sets and publications

5.53.1 USAF business rules

5.54 S1000D Chapter 6 - Information presentation and use

5.54.1 USAF business rules

5.55 S1000D Chapter 6.2 - Information presentation and use - Page-oriented publications

5.55.1 USAF business rules

5.56 S1000D Chapter 6.2.1 - Page-oriented publications - Page layout, paper publications, headers and footers

5.56.1 USAF business rules

5.57 S1000D Chapter 6.2.2 - Page-oriented publications - Typography and layout elements

5.57.1 USAF business rules

5.58 S1000D Chapter 6.3 - Information presentation/use - Interactive electronic technical publications

5.58.1 USAF business rules

5.59 S1000D Chapter 6.3.1 - IETP - Output specification

5.59.1 USAF business rules

5.60 S1000D Chapter 6.4.2 - Functionality - Functionality matrix

5.60.1 USAF business rules

5.61 S1000D Chapter 7.1 - Information processing - Introduction

5.61.1 USAF business rules

5.62 S1000D Chapter 7.2 - Information processing - Basic concepts

5.62.1 USAF business rules

5.63 S1000D Chapter 7.3.1.3 - Data module Schema - Invocation

5.63.1 USAF business rules

5.64 S1000D Chapter 7.4.1.1 - IETP - Generation process

5.64.1 USAF business rules

5.65 S1000D Chapter 7.5.1 - Information interchange - File based transfer

5.65.1 USAF business rules

5.66 S1000D Chapter 7.5.3 - Information interchange - Resource description framework/Dublin core metadata

5.66.1 USAF business rules

5.67 S1000D Chapter 8.4 - SNS, information codes and learn codes - Information codes

5.67.1 USAF business rules

5.68 S1000D Chapter 8.4.1 - Information codes - Short definitions

5.68.1 USAF business rules

6 NOTES

6.1 Intended use

6.2 Acquisition requirements

6.3 Subject term (key word) listing

6.4 Types of business rules

6.4.1 AF business rules

6.4.2 JSBRs

6.4.3 Project-specific business rules

6.5 Business rule and decision point numbering

MIL-STD-3048C(USAF)

CONTENTS

vi

6.5.1 JSBR numbering

6.5.2 AF business rule numbering

6.5.3 Business rule decision point numbering

6.6 Business rule development tools and assistance

6.7 Technical Order Authoring and Publishing (TOAP) system

6.8 Change notations

TABLE I. Joint Service Publication Acronym List

APPENDIX A PROJECT DECISION POINTS

A.1 SCOPE

A.1.1 Scope

A.2 GENERAL REQUIREMENTS

A.2.1 Intended use

A.3 DETAILED REQUIREMENTS

A.3.1 Tabular listing of Air Force project decision points A.3.2 Tabular listing of S1000D project decision points

APPENDIX B IETM FUNCTIONALITY REQUIREMENTS

B.1 SCOPE

B.1.1 Scope

B.2 MANDATORY FUNCTIONALITY REQUIREMENTS

B.2.1 Intended use

B.3 OPTIONAL FUNCTIONALITY REQUIREMENTS

B.3.1 Intended use

INDEX

CONCLUDING MATERIAL

MIL-STD-3048C(USAF)

CONTENTS

vii

1 SCOPE

1.1 Scope. This standard establishes the business rules for technical content, style, format, and functionality requirements (see 4.2 and 6.4) for United States Air Force (USAF or AF) technical publications prepared using the S1000D specification (a.k.a. S1000D). These rules provide the requirements for the implementation of S1000D for the preparation, development, and delivery of all technical publications for paper, page-oriented, and screen-based Interactive Electronic Technical Manuals (IETMs), irrespective of architecture or display devices.

1.1.1 Application to S1000D. This version of the standard is only applicable for use with S1000D, Issue 4.1.

See S1000D (Issue 4.1), Chapter 1.4.2, Paragraph 1.

1.2 Organization of the technical content. The business rules and decision points contained in Section 5 and Appendix A of this standard are arranged according to the chapter structure of the S1000D specification, with each of the primary chapters being broken down into their subchapters. The S1000D subchapters contained herein are limited to those that have applicable USAF business rules or Joint Service Business Rules (JSBRs) assigned.

S1000D is organized into the following nine primary chapters:

a. Chapter 1 - Introduction to the specification

b. Chapter 2 - Documentation process

c. Chapter 3 - Information generation

d. Chapter 4 - Information management

e. Chapter 5 - Information sets and publications

f. Chapter 6 - Information presentation and use

g. Chapter 7 - Information processing

h. Chapter 8 - Standard Numbering Systems (SNS), Information Codes (IC) and learn codes

i. Chapter 9 - Terms and data dictionary

1.2.1 JSBRs. JSBRs are business rules agreed upon by US military services. All JSBRs applicable to S1000D, issue 4.1, are contained in this standard in their entirety (see Section 5). A copy of the JSBRs, information names, information codes, and code variants can be obtained at https://www.navsea.navy.mil/Home/Warfare-Cen-ters/NSWC-Carderock/Resources/Technical-Information-Systems/, under the US Navy S1000D Information Cen-ter on the website. See 6.4.2.

1.2.2 Project business rule decision points. Additional project business rule decision points that must be addressed by the acquiring activity are contained in Appendix A. See 6.4.3.

1.3 Digital data preparation and delivery. This standard establishes requirements for preparation and delivery of digital data using S1000D schemas and application of best practices in tagging of technical data during the authoring process (see 4.3 and 4.4).

2 APPLICABLE DOCUMENTS

2.1 General. The documents listed in this section are specified in sections 3, 4, or 5 of this standard. This section does not include documents cited in other sections of this standard or recommended for additional information or as examples. While every effort has been made to ensure the completeness of this list, document users are cautioned that they must meet all specified requirements of documents cited in sections 3, 4, or 5 of this standard, whether or not they are listed.

2.2 Government documents.

2.2.1 Specifications, standards, and handbooks. The following specifications, standards, and handbooks form a part of this document to the extent specified herein. Unless otherwise specified, the issues of these documents are those cited in the solicitation or contract.

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z

Check the source to verify that this is the current version before use.

https://www.navsea.navy.mil/Home/Warfare-Centers/NSWC-Carderock/Resources/Technical-Information-Systems/ https://www.navsea.navy.mil/Home/Warfare-Centers/NSWC-Carderock/Resources/Technical-Information-Systems/

DEPARTMENT OF DEFENSE SPECIFICATIONS

MIL-DTL-5096 - Manuals, Technical - Inspection and Maintenance Requirements;

Inspection Work Cards; and Checklists; Preparation of MIL-DTL-5288 - Manuals, Technical - Aircraft Cargo Loading and Off-Loading MIL-DTL-38807 - Manuals, Technical - Illustrated Parts Breakdown MIL-DTL-7700 - Manuals, Technical - Flight Manual Program Publications MIL-DTL-8031 - Manuals, Technical - List Of Applicable Publications (LOAP) -

Preparation MIL-DTL-9854 - Manuals, Technical - Structural Repair (Aircraft) MIL-DTL-9977 - Manuals, Technical - Nonnuclear Munitions and Nuclear Weapons

Basic Information, Loading Procedures Manuals, Integrated Combat Turnaround Procedures Manuals, Loading Standard Data Packages, and Loading Procedures, Integrated Combat Turnaround Procedures, NATO Stage B Cross-Servicing, Functional Check Procedures, and End of Runway Procedures Checklists

MIL-DTL-22202 - Aircraft Cross-Servicing Manuals, Technical, Preparation of MIL-DTL-38804 - Manuals, Technical - Time Compliance Technical Orders (TCTO) and TCTO Supplements MIL-DTL-83495 - Manuals, Technical - On-Equipment Maintenance Manual Set MIL-DTL-87158 - Manuals, Technical - Aircraft Battle Damage Assessment and

Repair MIL-DTL-87929 - Manuals, Technical - Operation and Maintenance Instructions in

Work Package Format (for USAF Equipment) MIL-PRF-38311 - Manuals, Technical: Operation and Associated Checklist

(Intercontinental Ballistic Missile) Preparation of MIL-PRF-38314 - Manuals, Technical: Operation and Associated Checklist (Space

Systems) Preparation of MIL-PRF-38793 - Technical Manuals: Calibration Procedures - Preparation MIL-DTL-38769 - Manuals, Technical - Work Unit Code

DEPARTMENT OF DEFENSE STANDARDS

MIL-STD-38784 - General Style and Format Requirements for Technical Manuals

(Copies of these documents are available online at https://quicksearch.dla.mil.)

2.2.2 Other Government documents, drawings, and publications. The following other Government documents, drawings, and publications form a part of this document to the extent specified herein. Unless otherwise specified, the issues of these documents are those cited in the solicitation or contract.

TECHNICAL MANUALS

TO 00-5-1 - AF Technical Order System TO 00-5-3 - AF Technical Order Life Cycle Management TO 00-25-195 - AF Technical Order System Source, Maintenance, and

Recoverability Coding of Air Force Weapons, Systems, and Equipments

(Copies of these documents required by users with “.mil” government web address access are available online at https://www.my.af.mil/etims/ETIMS/index.jsp. Copies of documents required by contractors in connection with specific procurement functions should be obtained from the acquiring activity or as directed by the contracting officer.)

DEPARTMENT OF DEFENSE PUBLICATIONS

DoDI 5200.48 - Controlled Unclassified Information (CUI)

(Copies of this document are available online at https://www.esd.whs.mil/DD/.)

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z

Check the source to verify that this is the current version before use.

https://quicksearch.dla.mil https://www.my.af.mil/etims/ETIMS/index.jsp https://www.esd.whs.mil/DD/

CHAIRMAN OF THE JOINT CHIEFS OF STAFF

N/A - DoD Dictionary of Military and Associated Terms

(Copies of this document are available online at https://www.jcs.mil/Doctrine/DoD-Terminology-Program/ and https://www.dtic.mil/doctrine/dod_dictionary.)

AIR FORCE INSTRUCTIONS

DAFI 61-201 - Management of Scientific and Technical Information (STINFO)

AIR FORCE MANUALS

AFMAN 36-2100 - Military Utilization and Classification

(Copies of these documents are available online at https://www.e-publishing.af.mil. Copies of documents required by contractors in connection with specific procurement functions should be obtained from the acquiring activity or as directed by the contracting officer.)

U.S. GOVERNMENT PRINTING OFFICE

GP 1.23/4:ST 9/2016 - U.S. Government Publishing Office Style Manual

(Copies of this document is available online at https://www.gpo.gov.)

2.3 Non-Government publications. The following documents form a part of this document to the extent specified herein. Unless otherwise specified, the issues of these documents are those cited in the solicitation or contract.

AEROSPACE AND DEFENCE INDUSTRIES ASSOCIATION OF EUROPE (ASD), AEROSPACE

INDUSTRIES ASSOCIATION OF AMERICA (AIA), ATA E-BUSINESS PROGRAM

S1000D - International specification for technical publications utilizing a common source database (Issue 4.1)

(Copies of this document is available online at https://s1000d.org.)

AEROSPACE AND DEFENCE INDUSTRIES ASSOCIATION OF EUROPE (ASD)

ASD-STE100(STE) - ASD Simplified Technical English

(Copies of this document is available online at https://www.asd-ste100.org.)

AMERICAN SOCIETY OF MECHANICAL ENGINEERS (ASME)

ASME Y14.38 - Abbreviations and Acronyms for Use on Drawings and Related

Documents

(Copies of this document is available online at https://www.asme.org.)

INTERNATIONAL ORGANIZATION FOR STANDARDIZATION (ISO)

ISO 8601 - Data Elements and Interchange Formats - Information Interchange -

Representation of Dates and Times

(Copies of this document is available online at https://www.iso.org.)

WORLD WIDE WEB CONSORTIUM (W3C)

REC-xml-20081126 - Extensible Markup Language (XML) 1.0 (Fifth Edition)

(Copies of this document is available online at https://www.w3.org.)

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z

Check the source to verify that this is the current version before use.

https://www.jcs.mil/Doctrine/DoD-Terminology-Program/ https://www.dtic.mil/doctrine/dod_dictionary https://www.e-publishing.af.mil https://www.gpo.gov https://s1000d.org https://www.asd-ste100.org https://www.asme.org https://www.iso.org https://www.w3.org

2.4 Order of precedence. Unless otherwise noted herein or in the contract, in the event of a conflict between the text of this document and the references cited herein, the text of this document takes precedence. Nothing in this document, however, supersedes applicable laws and regulations unless a specific exemption has been obtained.

3 DEFINITIONS

3.1 Acronyms used in this standard. The acronyms used in this standard are defined as follows:

ASD AeroSpace and Defense Industries Association of Europe ASME American Society of Mechanical Engineers ATE Automatic Test Equipment AUR All Up Round BR Business Rule BREX Business Rules Exchange C-E Communications-Electronics CAGE Commercial and Government Entity CCT Conditions Cross-reference Table CIR Common Information Repository CLS Contractor Logistics Support CMBR Chemical Munitions/Biological Research CSDB Common Source Database CSL CSDB Status List CUI Controlled Unclassified Information DC Disassembly Code DDN Data Dispatch Note DFAR Defense Federal Acquisition Regulations DM Data Module DMC Data Module Code DMRL Data Management Requirement List DoD Department of Defense e.g. exempli gratia (for example) EIAC End Item Acronym Code EOR End of Runway FAR Federal Acquisition Regulations FSC Federal Supply Classification HCI Hardness Critical Item HTML HyperText Markup Language i.e. id est (that is) IC Information Code ICBM Intercontinental Ballistic Missile ICN Information Control Number ICV Information Code Variant IEC International Electro-technical Commission IETM Interactive Electronic Technical Manual IETP Interactive Electronic Technical Publication IPD Illustrated Parts Data ISO International Organization for Standardization JSBR Joint Service Business Rules JSITWG Joint Service IETM Technology Working Group LOAP List of Applicable Publications

MIL-STD-3048C(USAF)

LOEDM List of Effective Data Modules LOEP List of Effective Pages LOI List of Illustrations MIC Model Identification Code NATO North Atlantic Treaty Organization NCAGE NATO Commercial and Government Entity NIIN National Item Identification Number PCT Product Cross-reference Table PM Publication Module PMC Publication Module Code PPE Personal Protective Equipment SE Support Equipment SGML Standard Generalized Markup Language SMR Source, Maintenance, and Recoverability SNS Standard Numbering System SSCC Standard Subject Classification Codes STINFO Scientific and Technical Information SVG Scalable Vector Graphics TOAP Technical Order Authoring and Publishing TCTO Time Compliance Technical Order TM Technical Manual TMCR Technical Manual Contract Requirements TMSS Technical Manual Specifications and Standards TO Technical Order TOC Table of Contents UOC Usable On Code USAF United States Air Force WUC Work Unit Code XML Extensible Markup Language

3.2 Terms. S1000D terms and definitions can be found in S1000D, Chapter 9.2.1. The terms used in this standard are defined as follows:

3.2.1 Acquiring Activity. The DoD component, activity, or organization of a military service that is delegated with the selection, determination of requirements, and overall management for development and/or sustainment of Technical Manuals (TMs). The term “program” as used herein is synonymous with acquiring activity.

3.2.2 Applicability. The state or condition when associated data is valid (i.e., applying to a certain configuration, model, or even environmental condition). Applicability may also be used to describe how data modules pertain to different customers for delivery. The term “effectivity” is not used by S1000D.

3.2.3 Assembly. Two or more parts or subassemblies joined together to perform a specific function and capable of disassembly (e.g., brake assembly, fan assembly, audio frequency amplifier). Note that the distinction between an assembly and subassembly is determined by the individual application. An assembly in one instance may be a subassembly in another, where it forms a portion of an assembly.

3.2.4 Business Rules EXchange (BREX). An S1000D-authored data module containing machine-verifiable business rule decisions. The BREX data module provides a structure for standardized formal exchange and unambiguous definition of business rules.

3.2.5 Callout. Anything placed on an illustration to aid in identifying the objects being illustrated, such as index numbers, nomenclature, leader lines, and arrows.

MIL-STD-3048C(USAF)

3.2.6 Commercial and Government Entity (CAGE) Code. A unique identifier assigned to companies doing or who wish to do business with the Federal Government. Non-US companies are assigned a North Atlantic Treaty Organization (NATO) Commercial and Government Entity (NCAGE) Code. The code is five positions. The first and fifth position must be numeric. The second, third, and fourth positions may be any mixture of alpha/numeric excluding alpha letters I and O. For more information on CAGE Codes and CAGE Code assignments, visit https://cage.dla.mil/.

3.2.7 Expendability, Recoverability, Reparability Category. A code allocated to the sixth position of the SMR code.

3.2.8 End Item Acronym Code (EIAC). A code representing a final combination of end products, component parts, or materials that is ready for its intended use (e.g., tank, mobile machine shop, aircraft, receiver, rifle, recorder).

3.2.9 EXtensible Markup Language (XML). XML is a subset of Standard Generalized Markup Language (SGML) in accordance with REC-xml-20081126. It enables generic SGML to be served, received, and processed on the web in the way that is now possible with HyperText Markup Language (HTML). XML has been designed for ease of implementation and for interoperability with both SGML and HTML.

3.2.10 Filtering. The process of applying criteria based on the applicability information to determine what data is valid for a certain situation. Data modules can be filtered based on tail numbers, serial numbers, modifications, configurations, etc.

3.2.11 Functionality matrix. A procurement tool provided with S1000D that allows projects to specify required levels of functionality for both IETMs and page-oriented publications. Functionality requirements can be specified separately for all desired technical publication data types (e.g., theory of operation, diagnostics, parts, etc.).

3.2.12 Hardness Critical Item (HCI). HCI is an item that allows the equipment to meet nuclear survivability requirements (such as Over Pressure and Burst, Thermal Radiation, Electromagnetic Pulse, or Transient Radiation Effects on Electronics).

3.2.13 Icon. Icons are pictorial images which may be used in lieu of words.

3.2.14 Illustrated Parts Data (IPD). IPD are data modules that contain a listing of parts and their relationship.

This is equivalent to illustrated parts breakdown technical manuals.

3.2.15 Index number/Item number. Terms used interchangeably to mean a type of callout that is a number used to identify an item in an illustration or table.

3.2.16 Information set. Information sets define content depth requirements. Information set requirements can be collected together to provide an author with content depth requirements for a subset of data to be authored or an entire publication.

3.2.17 Interactive Electronic Technical Manual (IETM). Technical Manual authored in a non-linear fashion for the purpose of non-linear display. IETM organization facilitates easy user access to technical information while the display device provides interactive procedural guidance, navigational directions, and supplemental information. An IETM facilitates the interchange of maintenance manual information with logistic support data supplemental to maintenance, such as maintenance data collection, training documentation, supply interface and data presentation control. This is roughly equivalent to the S1000D term Interactive Electronic Technical Publication (IETP).

3.2.18 Interactive Electronic Technical Publication (IETP). A set of information needed for the description, operation and maintenance of the Product, optimally arranged and formatted for interactive screen presentation to the end user on an electronic display system. IETP includes conditional branching mechanisms, which can be based on user feedback. Parameters are evaluated at runtime and their values can depend on context and specific user input. This is roughly equivalent to the more common U.S. term IETM.

3.2.19 International Organization for Standardization (ISO). An organization that sets international standards, founded in 1946 and headquartered in Geneva. It deals with all fields except electrical and electronics, which is governed by the older International Electro-technical Commission (IEC), also in Geneva. With regard to information processing, ISO and IEC created the Joint Technical Committee for Information Technology.

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z https://cage.dla.mil/

3.2.20 Legend. A legend is a tabular listing and explanation of the numbers or symbols on a figure or an illustration.

3.2.21 Maintenance level. Maintenance levels are different kinds of maintenance activities which are separated based on complexity, required skills, and available facilities.

3.2.22 Maintenance task. A maintenance task is a complete start-to-finish, step-by-step maintenance action in a logical sequence of occurrence with a definite beginning and end.

3.2.23 National Item Identification Number (NIIN). The last nine digits of the National/NATO stock number.

The first two digits of the NIIN identify the country assigning the number and the remaining seven digits are a serially assigned number.

3.2.24 Nomenclature. The approved name or alphanumeric identifier assigned to an item, equipment, or component in agreement with an organized designation system.

3.2.25 Product. The Product is equipment or materiel that is the primary subject of the technical data. It can mean platform, system, equipment, assemblies, components, parts, etc.

3.2.26 Project. The task to develop, maintain, and dispose of the Product.

3.2.27 Reference designator. A reference designator unambiguously identifies a component in an electrical schematic or on a printed circuit board.

3.2.28 Revision. A revision is a second or subsequent edition of a publication which normally supersedes the preceding edition.

3.2.29 Source, Maintenance, and Recoverability (SMR) code. The five-position code containing supply/requisitioning information, maintenance level authorization criteria, and disposition instruction. The first two positions of the SMR code determine how to get an item. The third position represents who can install, replace, or use the item. The fourth position dictates who can do complete repair on the item. The fifth position represents who determines disposition action on unserviceable items. See Technical Order (TO) 00-25-195.

3.2.30 Special tools. Special tools are those tools that have been manufactured specifically to accomplish a single or peculiar maintenance action for a specific end item/system.

3.2.31 Standard Numbering System (SNS). An SNS consists of three groups of characters intended to provide standardization in the arrangement or addressing of the Product. It is part of the data module code.

3.2.32 Subassembly. Two or more parts that form a portion of an assembly or a component replaceable as a whole, but having a part or parts that are individually replaceable (e.g., gun mount stand, window recoil mechanism, floating piston, intermediate frequency strip, and mounting board with mounted parts).

3.2.33 Support Equipment (SE). An item of equipment required to maintain the Product in its operational status, including related computer programs.

3.2.34 Tailoring (business rules). Tailoring is the process of evaluating individual potential requirements to determine their pertinence and cost effectiveness.

3.2.35 Technical Manual (TM). A technical publication that contains instructions for the installation, operation, maintenance, and support of a weapon system, weapon system components, and support equipment. TM information may be presented, according to prior agreement between the contractor and the Government, in any form or characteristic, including hard printed copy, audio and visual displays, electronic imbedded media, disks, other electronic devices, or other media. They normally include operational instructions, maintenance instructions, parts lists, and related technical information or procedures exclusive of administrative procedures.

3.2.36 Usable On Code (UOC). A one to four character code from a logistics database which represents the applicable configuration in which an item is used.

3.2.37 Viewer. A viewer is a software program that allows technical data to be displayed, but not changed.

Viewers are often freely distributable and platform independent, even when the editor application is not. This characteristic allows authors to create technical publications with an editor application and make the viewer, which displays the technical publication, available to other users.

MIL-STD-3048C(USAF)

3.2.38 XML Schema. XML Schemas express shared vocabularies and allow machines to carry out rules made by people. They provide a means for defining the structure, content, and semantics of XML documents.

4 GENERAL REQUIREMENTS

4.1 General. Projects developing AF TMs in accordance with S1000D, pursuant to AF TO system policy (see TOs 00-5-1 and 00-5-3), shall comply with the requirements in this standard. The acquiring activity shall coordinate with the Life Cycle Management Branch (AFMC/A4FI) during the process of developing project business rules (see 4.2).

4.1.1 Legacy projects. Legacy programs/systems implementing S1000D in development/sustainment of TM data shall comply fully with the requirements of this standard.

4.2 Business rules. Projects developed in accordance with S1000D are required to include generation of business rules (see 5.1.1.3) that consist of a tailoring of the S1000D specification, with the aim of ensuring that clear expectations are communicated to all stakeholders (see S1000D, Chapters 1.4 and 2.5). This standard covers the requirements of business rule decision points that constitute the overall set of project business rules (see

5.1.1.1 and A.1.1). Project decisions developed under this standard in implementation of S1000D shall be in agreement with the associated USAF policy. Where a conflict exists, the USAF policy shall have precedence (see 5.1.1.2).

NOTE: It is imperative that a program’s functionality needs and objectives are clearly understood and met.

4.3 Preparation of digital data for electronic delivery. TM data prepared and delivered digitally in accordance with this standard shall be authored in XML using the schemas specified in S1000D (see 5.61.1.1). Use of the schemas in development of publications shall be in accordance with the requirements contained in this standard and S1000D. The schemas interpret the technical content, structure, and functional requirements contained in the S1000D specification and are mandatory for use. For additional information, refer to S1000D, Chapters 7.2 and

7.3.1. The schemas may be obtained from https://www.s1000d.org (see S1000D, Chapter 7.1, Paragraph 2.8 or Chapter 7.3.1, Paragraph 2).

4.4 Use of XML data elements for tagging technical data. XML data elements shall be used in accordance with the S1000D specification and any business rules that apply to the element. The following apply:

4.4.1 Tagging consistency. The S1000D schemas, along with some of the decision points described in Appendix A of this standard, are extremely flexible and allow for a multitude of methods to tag technical data.

Projects shall be accomplished with consistent methodology in tagging the data as well as in population of elements and attributes. In other words, if there are two or more equally viable ways of tagging a certain type of technical data, the project shall use one method consistently throughout the publication. The choice of tags shall be consistent with or match the type of technical data as closely as possible in order to serve as true metadata of the content.

4.4.2 Intelligent data. Authors of the technical data shall provide as much intelligence to the data as possible by making use of all applicable elements and attributes, as instructed in the S1000D specification, and as tailored in the project business rules, when applicable. For example, if there is a part number that is listed in a paragraph, the part number shall be tagged using the appropriate elements (i.e., <partNumber>) and not left as plain text within the <para> element. As another example, an acronym within the text shall be tagged with the <acronym> element or with the element <acronymTerm> and linked to the corresponding <acronym> element.

5 DETAILED REQUIREMENTS

5.1 S1000D Chapter 1.4 - Introduction to the specification - How to tailor for a specific project.

5.1.1 USAF business rules.

5.1.1.1 Development of project business rules (JS-001). The project shall develop business rules documenting the details of the tailoring of S1000D for a specific project. These rules shall include documented decisions for every decision point.

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z https://www.s1000d.org

5.1.1.2 Priority of project’s business rules (JS-002). Project business rules shall not contradict or supersede higher-level JSBRs, or Service level business rules, or requirements contained within S1000D.

5.1.1.3 Development and sustainment of project business rules (JS-003). Project business rules shall be developed prior to the start of development of technical data. Business rules shall be updated throughout the life of the project as necessary to reflect the project environment.

5.2 S1000D Chapter 1.5 - Introduction to the specification - Request for change.

5.2.1 USAF business rules.

5.2.1.1 Changes to S1000D. All requests for formal changes to the S1000D specification and supporting schemas shall be submitted via email to SGMLsupport@us.af.mil for coordination through AFMC/A4FI and the S1000D process for change management.

5.3 S1000D Chapter 3.4 - Information generation - Zoning and access.

5.3.1 USAF business rules.

5.3.1.1 Determine best zoning (granularity) methodology (JS-004). When zoning and access information is a requirement for data modules, zones and access points shall be determined in accordance with the principles, requirements, and coding as defined in S1000D. Full zoning and access point definitions shall be defined within project business rules.

5.4 S1000D Chapter 3.5 - Information generation - Updating data modules.

5.4.1 USAF business rules.

5.4.1.1 Frequency of updates. Projects shall arrange their frequency of updates, including Time Compliant Technical Orders (TCTO) in accordance with TO 00-5-1, TO 00-5-3, and MIL-DTL-38804.

5.5 S1000D Chapter 3.6 - Information generation - Security and data restrictions.

5.5.1 USAF business rules.

5.5.1.1 Marking of security classifications (JS-095). Security classifications shall be marked in accordance with DoD information security program instructions/directives. The project or organization business rules shall identify the latest instructions/directives at time of contract award.

5.5.1.2 Retention of security classifications (JS-094). The retention of security classification markings shall be in accordance with DoD information security program instructions/directives. The project or organization business rules shall identify the latest instructions/directives at time of contract award.

5.5.1.3 Classifying the Common Source DataBase (CSDB). Projects shall classify the CSDB at the same level of classification as the highest object within the CSDB and in accordance with DoD information security program instructions/directives. The project or organization business rules shall identify the latest instructions/directives at time of contract award.

5.5.1.4 Classifying the publications. Projects shall classify publication modules at the same level of classification as the highest object within the publication module in accordance with DoD information security program instructions/directives. The project or organization business rules shall identify the latest instructions/directives at time of contract award.

5.5.1.5 Use of NATO classified data (JS-018). Foreign and NATO classified data shall not be used. NOTE: Use of this rule for joint-nation projects is a project decision.

5.5.1.6 Use of commercial security classifications. Commercial security classifications shall not be used.

5.5.1.7 Presentation of commercial classification and/or caveat as security markings (JS-093). Neither commercial classification nor national caveat shall be used as an alternative to security classification.

5.5.1.8 Marking of Controlled Unclassified Information (CUI). Publications containing CUI shall be marked as such in accordance with DoDI 5200.48. The attribute caveat within the element <security> shall be used for this purpose (see 5.37.1.2). The element <policyStatement> within <pmStatus> shall contain the CUI designation indicator information.

MIL-STD-3048C(USAF)

Source: http://assist.dla.mil -- Downloaded: 2024-01-24T16:23Z mailto:SGMLsupport@us.af.mil

5.6 S1000D Chapter 3.7 - Information generation - Quality assurance.

5.6.1 USAF business rules.

5.6.1.1 Final delivery of unverified data modules (JS-005). Final delivery to the customer shall not include unverified data modules. At a minimum, <qualityAssurance> must be <firstVerification> (first verification or validation).

5.6.1.2 Draft delivery of unverified data modules (JS-006). Draft data modules (i.e., inwork not equal to “00”) may only be exchanged for the purposes of validation/verification and for other purposes expressly specified by the project.

5.6.1.3 Degree of application of quality assurance. Projects shall follow all quality assurance, certification, and verification requirements detailed in TO 00-5-3.

5.6.1.4 Application of first verification. Projects shall consider first verification as equivalent to contractor certification as detailed in TO 00-5-3.

5.6.1.5 Application of second verification. Projects shall consider second verification as equivalent to USAF verification as detailed in TO 00-5-3.

5.7 S1000D Chapter 3.9.1 - Authoring - General writing rules.

5.7.1 USAF business rules.

5.7.1.1 Grammar and writing (JS-007). When using Standard American English, the U.S. Government Publishing Office Style Manual (GP 1.23/4:ST 9/2016) shall be used as a general guide for standard American English usage and punctuation. To determine and convey the proper spelling and meaning of words, Webster’s International Dictionary of the English Language shall be used.

5.7.1.2 Military and associated terms and abbreviations. Military and associated terms and abbreviations shall be in accordance with Joint Publication 1-02.

5.7.1.3 Engineering and related terms and abbreviations. Engineering and related terms and abbreviations shall be in accordance with ASME Y14.38.

5.7.1.4 Units of measurement. When only one standard of measurement is needed, projects shall use U.S.

customary units (ounces, pounds, gallons, inches, feet, knots, miles, etc.) as the standard units of measurement.

When more than one standard of measurement is needed, projects shall use U.S. customary units as either the primary or secondary units of measurement.

5.7.1.5 Static numbering. Projects shall autogenerate the numbering of paragraphs, procedural steps, figures, and tables.

5.8 S1000D Chapter 3.9.2.1 - Illustration rules and multimedia - Illustrations, General.

5.8.1 USAF business rules.

5.8.1.1 Procedural data in figures (JS-091). Figures shall not contain procedural steps.

5.9 S1000D Chapter 3.9.2.3 - Illustration rules and multimedia - Use of color and photographs.

5.9.1 USAF business rules.

5.9.1.1 Use of color. The use of color shall be in accordance with the S1000D color palette.

5.9.1.2 Use of photographic illustrations (JS-008). Photographic illustrations shall not be used unless prior approval has been obtained from the acquiring activity. Photographs shall not be used in foldouts.

5.10 S1000D Chapter 3.9.2.4 - Illustration rules and multimedia - Multimedia, General.

5.10.1 USAF business rules.

5.10.1.1 Classified multimedia. Multimedia shall not have a classification higher than “Unclassified.”

MIL-STD-3048C(USAF)

5.11 S1000D Chapter 3.9.2.5 - Illustration rules and multimedia - Interactive 3D content.

5.11.1 USAF business rules.

5.11.1.1 Classified 3D content. Interactive 3D content shall not have a classification higher than “Unclassified.”

5.12 S1000D Chapter 3.9.3 - Authoring - Warnings, cautions, and notes.

5.12.1 USAF business rules.

5.12.1.1 Use of warnings and cautions in descriptive data (JS-009). Warnings and cautions shall not be used in descriptive data modules, except in the case of a publication’s safety summary (e.g., IC 012).

5.12.1.2 Safety summary data module. When required by the acquiring activity, projects shall deliver an individual descriptive data module containing a publication’s safety summary (e.g. IC 012), which shall be authored in accordance with MIL-STD-38784.

5.12.1.3 Warnings in separate data modules (JS-010). Delivered data modules with procedures that require warnings shall not reference warnings in a separate data module. Delivered data modules shall contain the warning content.

NOTE: This does not prohibit the use of CIRs (see 5.32.1.1).

5.12.1.4 Cautions in separate data modules (JS-011). Delivered data modules with procedures that require cautions shall not reference cautions in a separate data module. Delivered data modules shall contain the caution content.

NOTE: This does not prohibit the use of CIRs (see 5.32.1.1).

5.12.1.5 Notes in separate data modules (JS-012). Delivered data modules that require notes shall not reference notes in a separate data module. Delivered data modules shall contain the note content.

NOTE: This does not prohibit the use of CIRs (see 5.32.1.1).

5.12.1.6 Warning, caution, and note placement (JS-013). Warnings shall be presented immediately after the label (step or para number) and the associated title (if present) and immediately preceding the associated text.

Cautions shall be presented immediately after the label (step or para number) and the associated title (if present) and immediately preceding the associated text. If multiple warnings, cautions, and notes apply to the same text, warnings shall appear first, cautions shall appear second, and notes shall appear last.

5.12.1.7 Authoring warnings and cautions. The content of warnings and cautions shall be in accordance with

MIL-STD-38784.

5.12.1.8 Use of the attribute vitalWarningFlag. Projects shall not use the attribute vitalWarningFlag.

5.12.1.9 Inclusion of the attribute warningType. Projects shall not use the attribute warningType.

5.12.1.10 Inclusion of the attribute cautionType. Projects shall not use the attribute cautionType.

5.12.1.11 Inclusion of the attribute noteType. Projects shall not use the attribute noteType.

5.13 S1000D Chapter 3.9.4 - Authoring - Front matter.

5.13.1 USAF business rules.

5.13.1.1 Use of List of Effective Pages (LOEP) or List of Effective Data Modules (LOEDM) (JS-014). Publications shall have a LOEDM. Publications shall not have a LOEP.

5.13.1.2 Presentation of issue date or the issue number in the List of Effective Pages (LOEP) (JS-109). See

JS-014 (5.13.1.1).

5.13.1.3 List of Effective Data Modules (LOEDM) content (JS-015). The LOEDM shall present, at a minimum, the data module code, the data module title, and issue number. The inwork number shall not be presented.

5.13.1.4 Links from the change record data module. Projects shall provide links from the change record data module to those data modules that contain changed content.

MIL-STD-3048C(USAF)

5.14 S1000D Chapter 3.9.5.1 - Data modules - Identification and status section.

5.14.1 USAF business rules.

5.14.1.1 Allocation of the ICs and the information names (JS-107). The Joint Service ICs and information names shall be used. It is not required that ICVs be limited to use with a single specific schema type.

5.14.1.2 Language. The value of the attribute languageIsoCode shall be set to English (“en”) or, for Simplified Technical English, (“sx”), and the value of the attribute countryIsoCode shall be set to the United States (“US”).

5.14.1.3 Use of element <issueDate> (JS-057). For classified documents, the element <issueDate> shall contain the date of the document as specified in DoD information security program instructions/directives. The project or organization business rules shall identify the latest instructions/directives at time of contract award. For unclassified documents, the process for determining the dates of issue for publications and data modules shall be decided by the project.

5.14.1.4 Use of the element <infoName> (JS-016).