1 概述
本章概述了：
- 本规范的结构和内容
- 基本的生产和交付方法
- 基本阅读规则
2 应用领域
S1000D是一项国际规范，旨在涵盖支持任何平台、系统或设备项目（空中、海上、陆地车辆、设备或设施、民用或军用）的技术出版物和学习信息。
描述了技术出版物和培训信息的以下方面：
- 信息生成（创作）
- CSDB内部的管理
- 出版物生成-面向页面和IETP
- 交换数据模块、出版物和培训内容包
- 评论
本规范阐述了技术出版物和培训内容包的两种主要交付方法：
- 数据交换-S1000D对象（数据模块和支持对象）交付以供进一步处理
- 出版 - 出版物和培训内容包的交付, 随时可用的信息
有关交付方法的更多详细信息，请参阅第5段。
3 基本定义
| 项 | 定义 |
|---|---|
| 产品 | 包括任何平台、系统或设备（空中、海上、陆地车辆、设备或设施、民用或军用） |
| 项目 | 开发、维护和处置产品的任务 |
| 技术出版物 | 运行和维修文档和数据。技术出版物不包括设计文件（如设计图纸或CAD模型）。 |
| 学习信息 | 用于开展培训活动的信息，有助于学习和发展新的和现有的技能。 |
| 自包含数据模块 | 一种随时可用的数据模块，无需任何公共信息存储库数据模块，参见第4页。 |
| 依赖于CIR的数据模块 | 需要访问一个或多个公共信息存储库（CIR）数据模块的数据模块，参见第4页。 |
4 自包含的与依赖CIR的数据模块
数据模块和出版物的制作（创作）和交付（发布）有两种基本方法：
- 仅使用自包含的数据模块，这是交付数据模块的基本方法。
- 使用公共信息存储库数据模块（例如，警告、注意、外部化的适用性注释）作为交付的必要部分，此方法意味着“普通”数据模块的交付依赖于CIR。
CIR提供了进一步优化和重用数据的能力，它通过以下方式实现这一点：
- CIR数据模块，请参阅第4.13.1章
- CIR数据模块的增量更新，请参阅第4.13.2章。
- 替代，请参阅第4.13.3章。
- 容器数据模块，请参阅第4.13.4章
注：CIR概念可以作为“内部存储库”在生产过程中实现，因此不一定作为CIR数据模块。
使用CIR数据模块从生产环境中交付可以通过两种方式完成：
-
自包含数据模块。
这些数据模块包括理解说明或完成维护任务所需的所有信息。来自CIR数据模块的数据（例如，警告、注意、外部适用性注释），如果使用，将包含（未链接）在要交付给客户或最终用户的数据模块中。例如，如果使用了警告、注意和/或适用性CIR，则必须将其包括在其适用的数据模块中，如果自包含数据模块是可交付物。
注：数据模块中只能包含来自存储库数据模块的有限数据集。
注：CIR数据模块仍然可以与自包含的数据模块一起交付，因为存储库数据模块包含有用的附加/详细信息，这些信息不能包含在数据模块中，而是在IETP中使用。 -
依赖于CIR的数据模块
这些数据模块依赖于CIR数据模块，因为在交付给客户或最终用户（或IETP应用程序）之前，信息片段被“删除”或外部化到一个或多个CIR数据模块中。客户、最终用户或IETP应用程序在使用IETP查看器/浏览器之前或使用过程中解析任何链接。
这两种方法的创作规则有所不同，在创作章节中对此进行了解释。请参阅第3.9.5.2.1章。使用CIR数据模块时，某些信息不需要编写，但需要引用（链接）到相应的CIR数据模块。例如，正在引用（链接）到CIR数据模块而不是编写的支持设备的名称。
有关CIR概念使用的详细信息，请参阅第4.13.1章。
有关容器概念使用的详细信息，请参阅第4.13.4章。
5 交付方式
5.1 数据交换
当接收组织拥有CSDB时，使用基于S1000D对象数据交换（参考段落2）的交付方法，并期望处理数据，甚至包括变更（例如，由于数据模块适应内部法规和需求）。然后，接收者可以生成另一个交换包或生成最终的即用出版物或SCORM内容包模块，参见图1。
数据交换在两个CDSB（发送方CSDB和接收方CSDB）之间完成。交换可以是分包商和主承包商之间的交换，也可以是承包商和客户之间的交换。
数据交换包主要由数据模块及其相关插图和多媒体文件组成。还可以交换发布模块、SCORM内容包模块和支持文件，如数据发送说明和数据管理列表。
传输包的交换按照第4.8章所述进行。
5.2 交付现成出版物或培训内容包
当CSDB所有者、承包商或客户向最终用户交付最终即用产品时，使用此方法。它可以是以活页夹形式的纸质出版物或PDF格式的电子出版物（后者带有一些链接机制）的面向页面的出版物。可交付成果也可以是按照第7.4.1章所述生成的IETP或培训相关产品。后者可用作SCORM、即时培训、讲师或学生指南。
5.3 有或者无CIR的交付
数据模块的交换可以基于自包含或依赖于CIR的数据模块来完成。
依赖CIR的数据模块的交换（传输）包必须随附相关CIR
自包含数据模块的交换包不一定包括任何CIR。但是，在合作伙伴（分包商和承包商）之间交换CIR，以获得供应品、支持设备、警告和注意的一致数据，可能是有用的。
图2显示了不同CSDB之间的数据交换。它还简要说明了通过第7.4.1章中描述的中性IETP-X格式从CSDB到最终用户IETP的“数据传输”。
6 阅读约定
6.1总则
在整个S1000D中，使用特定的约定来帮助达成共识并最大限度地减少重复。这些约定是：
| 项 | 约定 |
|---|---|
| 可用于项目 | SNS和属性值，可用于项目或组织，以给出其自己的特定定义。 |
| 不适用于项目 | SNS、信息代码和属性值，这些信息代码和属性值不适用于项目或组织，无法给出自己的特定定义。项目或组织可以通过正常的CPF流程申请正式定义。 |
| M |
强制 受影响的属性必须在数据模块中给定，并且必须填充构造中所需的条目。 注：（M） 在某些章节中使用，例如，解释特定数据的使用或表示。 |
| O |
可选 如果项目或组织决定，则可以忽略受影响的属性。 注：（O） 在某些章节中使用，例如，解释特定数据的使用或表示。 |
| （D） |
默认值。 受影响的标记值是默认值。 |
| 企业/公司 |
企业是指公司和/或组织时的通用术语。当提及商业组织时，公司被用作企业的同义词。 术语制造商（产品制造商、设备制造商、飞机制造商）和供应商仅在上下文需要时使用。这些规则在S1000D中相继引入。 |
| 必须 | 强制遵守给定的规则。 |
| 命名 | “事物”的名称，例如零件、组件、部件。有时称为描述、命名或命名。名称在整个S1000D中始终使用。 |
| 可以 | 可以选择项目或组织决策所遵循的选项。 |
6.2 代码和数字中允许的字符
在整个S1000D中，以下给出了代码（如数据模块代码、出版模块代码、学习代码、学习事件代码、数据管理列表）和数字（如版本号）中使用的允许字符（字母和数字）的定义。
6.2.1 字母字符
代码缩写为“A”。
允许的字符为：
- 大写的“A”到“Z”。建议避免使用“I”和“O”。
6.2.2 数字字符
代码缩写为“X”。
允许的字符为：
- “0”至“9”
注：“NN”通常用于表示从“00”或“01”开始的数字序列。规范中使用的地方给出了解释的详细信息。
6.2.3 字母数字
代码缩写为“Y”。
允许的字符为：
- “0”至“9”
- 大写的“A”到“Z”。建议避免使用“I”和“O”。
6.2.4 特定字母字符值
当在数据模块代码中给出用于指示值的alpha字符时，通过在该字符下划线来表示。例如，“A”表示值“A”，而不是字母字符。“A”表示字母字符，而不是值“A”。
6.2.5 字母字符“I”和“O”的使用
业务规则决策点BRDP-S1-00001 - 使用“I”和“O”：
- 决定是否以及何时使用字母字符“I”和“O”。
7 CAGE代码的使用和应用
该规范使用CAGE（商业和政府实体）代码来唯一标识企业和组织。某些元素和属性的值要求使用注册的CAGE代码，例如，在DME和PME中使用标识扩展时（参考第4.12章），在使用基于CAGE代码的ICN时（参考第4.4章），使用数据管理列表时（参考第4.5章）和使用注释模式进行注释时（参考第4.6章）。要执行基于文件的传输（请参阅第7.5.1章），还需要CAGE代码。
由于在许多情况下必须唯一标识零件，因此本规范将这些零件的标识建立在CAGE代码的基础上。
业务规则决策点BRDP-S1-00002 - 技术出版物项目使用的许可CAGE代码和/或名称列表：
- 创建允许的CAGE代码和/或企业名称列表。
没有CAGE代码的企业和组织可以在其国家编目局（NCB）或以下地址申请代码：
NSPA
S2000M管理员
L-8325
CAPELLEN
G-D.卢森堡
邮件：Spec2000M@nspa.nato.int
8 首字母缩略词
在整个S1000D中，通用首字母缩略词用于帮助理解和减少重复。这些首字母缩略词是：
| 项 | 定义 |
|---|---|
| 2D | 二维 |
| 3D | 三维 |
| ASD | 欧洲航空航天和国防工业协会 |
| ATA | 航空运输协会 |
| BREX | 业务规则交换 |
| CAGE | 商业和政府实体 |
| CGM | 计算机图形元文件 |
| CIR | 公共信息存储库 |
| CPF | 变更提议表单 |
| CSDB | 公共源数据库 |
| CSN | 目录序号 |
| IC | 信息代码 |
| ICN | 信息控制编号 |
| IETP | 交互式电子技术出版物 |
| IPD | 图解零件数据 |
| LMS | 学习管理系统 |
| LOAP | 适用出版物清单 |
| LOM | 学习对象元数据 |
| LSA | 后勤保障分析 |
| 可移植文档格式 | |
| PLCS | 产品生命周期支持 |
| QA | 质量保证 |
| SCO | 可共享内容对象 |
| SGML | 标准通用标记语言 |
| SCORM | 可共享内容对象参考模型 |
| SNS | 标准编号系统 |
| XML | 可扩展标记语言 |
第9.2章列出了所有首字母缩略词的列表。
9 S1000D的组织
S1000D分为九章，下文简要介绍。
表2 S1000D结构概述
| 章节 | 标题 | 说明 |
|---|---|---|
| 第1章 | 规范简介 | 规范历史、规范范围、基本定义和变更程序 |
| 第2章 | 文件编制流程 | 文档过程概述、实施指南、业务规则概念以及与其他规范的关系 |
| 第3章 | 信息生成 | 一般规则适用于基于数据模块和CSDB概念生成的技术出版物 |
| 第4章 | 信息管理 | 数据模块结构、数据模块交换和更新规则。使用BREX的概念、过程数据模块、主定制数据模块、信息的适用性、优化和重用 |
| 第5章 | 信息集和出版物 | 信息集和出版物的通用和特定要求 |
| 第6章 | 信息展示/使用 | 面向页面出版物的信息展示和功能，以及IETP |
| 第7章 | 信息处理 | 给信息系统专家的信息，包括Schema、图形和符号规范、资源、分辨率和交换约定 |
| 第8章 | SNS、信息代码和学习代码 | 维护系统/功能分解结构的列表和定义、信息代码和学习代码 |
| 第9章 | 术语和定义 | 术语和缩写词汇表、主题索引和XML数据元素定义 |
9.1 各章概览
总的来说，所有章节的结构如下：
- 在本章的开头，有本章中出现的参考文献表。
- 第1段作了一般性介绍。
- 第2款是本章的主体部分。正文可分为几个主要内容段落。本段还提供了上下文中描述的所有业务规则。
- 第3段包含标记示例（如有）。简短/简单的例子也可以在主体段落中找到。
9.2 第1章-规范简介
本章提供了有关规范的一般信息。说明了规范的范围、如何使用规范、如何定制规范以及解决变更请求的方法。
9.3 第2章-文件编制流程
本章介绍通用文档编制过程。它概述了文件编制过程，包括信息技术的使用以及与其他过程和规范（例如S2000M和PLCS）的关系。通过流程图，还定义了对相应章节的参考。
第2.5章包含了业务规则的定义，并讨论了业务规则的各个方面，如分类、分层、生成和使用。第2.5.3章给出了所有确定的业务规则决策点的索引。
9.4 第3章-信息生成
本章提供了适用于基于数据模块和CSDB概念制作的技术出版物的一般规则。本章主要是为了支持内容作者和插图制作者。
所有数据模块都具有第3.2章中定义的基本结构。
信息集用于确定信息和数据模块编码策略的所需范围。这些信息集的使用在第3.3章中有完整的定义。
分区和访问规则见第3.4章。
第3.5章解释了与数据模块更新相关的问题。
第3.6章详细介绍了数据模块保护标记的分配规则，这些标记反映了数据模块的安全分类等。
在开发和更新数据模块/出版物的过程中，需要质量保证程序，以确保数据模块/出版物的内容充分且技术准确。有关这些程序的详细信息，请参见第3.7章。
为了反映设备的潜在故障，拆卸规则详见第3.8章。
所有数据模块均按照结构规则生产。文本、插图和多媒体的创作规则，以及封面和警告、注意事项和注释，强化了这些结构规则，这些规则得到了包括学习内容类型在内的数据模块创作具体指南的支持。这些规则见第3.9章。
本章还包括填充支持数据模块类型的规则：
- 公共信息存储库数据模块
- 容器数据模块
- 支持第4.14章中给出的适用性模型的数据模块
在所有情况下，本规范所有章节中给出的规则优先于模式。
注：在某些结构中，由于简化了Schema设计和减少了维护，Schema允许比规范叙述中给出的更多。
9.5 第4章-信息管理
介绍了数据模块的代码结构、数据模块的交换和更新规则。本章旨在支持项目数据模块、插图、出版物和SCORM内容包模块（SCPM）管理。
信息管理包括数据模块（第4.2章）、插图和出版物等信息对象的寻址、存储和处理，以便在项目中制作和使用通用技术文档。
本章包含建立信息数据库（称为CSDB）（第4.2章）、交换数据（第4.8章）以及处理从CSDB衍生的出版物（第4.9章）和培训内容包（第4.15章）所需的信息。
本节还详细介绍了数据模块的编码（第4.3章）及其相关插图和多媒体信息（第4.4章）。它描述了用于规划、管理和控制CSDB内容的数据管理列表（第4.5章），并定义了对数据模块和出版物评论的处理（第4.6章）。本章还介绍了启用数据模块、发布模块和SCORM内容包模块版本控制的方法（第4.7章）。
介绍了BREX（第4.10章）的使用、项目特定BREX的开发以及过程数据模块的使用（第4.11章）。
主定制概念（第4.12章）中描述了管理多客户环境。
本章还包括优化和重用数据的概念（第4.13章）。优化和重用包括处理数据模块内的重要数据，以及对与不同技术信息类型相关的属性进行分组的机制，以减少冗余信息并提高支持一致性（CIR数据模块概念）。还描述了一种生产管理机制，用于将表示相同数据的多个数据模块与不同的产品配置（容器数据模块概念）相关联。
提出了一个适用性模型，可用于从简单到非常复杂的许多不同层次。该模型能够支持从静态文本输出到动态输出，动态输出根据产品实例的实际配置进行过滤。解释了适用性模型的概述和功能（第4.14章）。
第4.15章支持用于培训和绩效产品的学习内容的聚合。该支持通过使用SCORM内容包模块进行管理。SCPM文档结构基于SCORM内容聚合模型。SCORM内容包模块模式允许课件开发人员将学习和维护模块收集到培训产品中。SCPM主要用于协助编制S1000D培训材料，以便通过符合SCORM的学习管理系统进行演示。
第4.16章解释了如何管理特定内容（技术信息和段落重要数据）和数量数据的专用标记，以增强信息的处理和/或显示。
9.6 第5章-信息集和出版物
本章包含操作和维护产品所需的信息集和出版物的通用和特定要求。本章主要针对项目出版物采购、管理、作者和插图制作者。
信息集是定义范围和深度（作者的观点）所需的必要信息，以数据模块的形式在CSDB中管理。
发布是为客户（用户视图）编辑和发布信息。这可以是IETP、从数据模块编译的纸质出版物或具有遗留数据的出版物。它可以是一个信息集的子集，也可以等于一个信息集，但也可以是多个信息集或其中的一部分的超集。
信息集要求见第5.2章，出版物要求见第5.3章。
9.7 第6章-信息展示/使用
本章提供面向页面的出版物（第6.2章）和IETP（第6.3章）的信息表示和使用规则。第6.4章解释了面向页面的出版物（基于纸张和屏幕）的功能矩阵，以及以非线性方式显示的信息。本章主要用于支持项目出版物采购、管理、作者、插图制作者和信息技术专家。
9.8 第7章-信息处理
本章描述了Schema、图形和符号的技术方面，以及信息交换、资源解析和软件需求。
9.9 第8章-SNS、信息代码和学习代码
本章描述了常见SNS和数据模块代码中使用的信息代码。
S1000D维护的SNS集在第8.2章中给出，用于飞行器、发动机和设备、战术导弹、通用陆地和通用海上产品的支持设备。
第8.3章提到了SNS的示例（例如，电源供应、炮兵雷达、软件、医疗和技术出版物项目）。S1000D网站（www.S1000D.org）上给出了这些示例SNS。
第8.4章给出了信息代码的详细定义，第8.5章给出了学习/培训代码。
9.10 第9章-术语和定义
本章提供S1000D中使用的术语表（第9.2.1章）、缩写和首字母缩略词（第9.2.2章）。还包括主题索引（第9.2.3章）。XML数据元素的定义见第9.3章。
< 回到目录