交互式电子技术手册结构化数据适用性研究

2021-07-08王刚

数码影像时代 2021年8期

王刚

引言

飞机在生产线制造完成时便具有确定的构型。在交付和使用阶段，由于用户需求、技术改进改型等因素，会产生构型差异和使用维护条件的差异。飞机技术出版物内容必须与所描述飞机的实物构型保持一致，因此，向不同用户交付的技术出版物由于构型差异，内容也会存在差异。通常，影响技术出版物内容产生差异的主要因素有型号、序列号、设备改型号、服务通告、维护作业位置（如航线、机库、车间），用户的经验级别等。

飞机技术出版物需包含所有不同构型的技术内容，在向用户交付时，只交付包含该用户所持有的适用飞机的内容。因此在技术出版物中引入了适用性的概念，在技术出版物中定义数据内容的适用范围。

适用性概述

采用S1000D规范制作交互式电子技术手册，数据模块及其内容片段对应飞机不同的构型。适用性的目的是通过在出版物内容中标注适用性，应用软件系统或程序可将满足条件的技术内容过滤并提取出来，以满足特定用户、特定飞机产品、特定技术条件和环境下的飞机使用维护需要。

适用性（Applicability）提供了识别数据模块或数据模块的内容片段是否有效的机制。数据模块通常与产品的物理构型相关，但也可能涵盖如工具可用性、环境条件等其他方面的信息。适用性的应用范围跨度很广，从一个数据模块某处的一个简单声明到管理生命周期的适用性，包括产品定义、适用性编写和产品实例构型跟踪等。

适用性规则

适用性机制

在S1000D规范中定义了技术出版物适用性的机制，主要包括：适用性声明（Applicability Declaration）、适用性注释（Applicability Annotation）、适用性过滤（Applicability Filtered view）。

适用性声明

为了对技术出版物中应用的适用性信息进行生命周期管理，定义三类特定的适用性数据模块，分别是：产品属性交叉引用表数据模块（Applicability Cross-reference Table Data Module，ACT DM），定义了影响技术出版物内容适用性的产品属性，如型号、批次、序列号、零件号（选型）等，产品属性一般为产品的“不可变信息”;条件交叉引用表数据模块（Conditions Cross-reference Table Data Module，CCT DM），定义影响技术出版物内容适用性的各类条件，如气象条件、服务通告等;产品交叉引用表数据模块（Products Cross-reference Table Data Module，PCT DM），定义了产品实例信息库，每个产品实例都包含了若干ACT和CCT中定义的产品属性和条件。

适用性数据模块

ACT、CCT、PCT三类数据模块用于对适用性信息进行定义、管理及被DM引用，在出版物编写和管理阶段应用。

ACT数据模块

ACT数据模块用于声明对数据适用性产生影响的产品属性。产品属性在产品的设计生产阶段确定，且在全寿命周期内通常不会改变，例如，型号（model）。

ACT数据模块是对适用性定义的参考中心点，提供了对一个CCT和一个PCT的数据模块的参引，所有需要适用性过滤的数据模块（DM）、出版物模块（PM）内容，必须在其标识和状态段参引一个ACT数据模块。

通过ACT数据模块与CCT DM、PCT DM的结合，可实现利用ACT数据模块访问所有适用性定义及产品实例取值，实现适用性过滤。

ACT数据模块包含下列部分：产品属性的定义（元素<productAttributeList>）（必选）、对CCT数据模块的参引（元素<condCrossRefTableRef>）（可选）、对PCT数据模块的参引（元素<product-CrossRefTableRef>）（可选）。

ACT数据模块的顶层结构图如图1所示。

产品属性可根据特定需求定义，可以定义多个产品属性信息，如下表所示。

CCT数据模块

CCT数据模块用于声明影响数据适用性的条件。条件可以是技术性、操作性、环境性或任何其他类型的影响数据适用性的条件，CCT DM允许任何条件创建。

技术条件通常与产品的物理构型相关，例如服务通告、工程指令和改型。技术条件的状态在产品实例的服务生命周期可以变更，技术条件应随产品实例跟踪。

操作条件与产品操作或维护时的条件相关。这些条件通常不作为产品构型的组成部分且不需跟踪。操作条件有受规章影响的ETOPS要求等;维护条件有可用工具、内部或外部电源以及维修位置（户内或户外）等。

环境条件与维护时或维护前操作期间的环境条件相关，例如温度、风速、是否有雨、风沙情况等。

其他条件不限定。条件可以与技术文档可用性信息相关。例如，当培训和技术数据更加综合化时，根据执行维护的人员的资质和训练记录创建条件，并且技术数据可以根据人员资质进行剪裁。

在CCT DM中，首先定义一个常用条件类型，然后为该类型条件定义一个具体的条件。CCT DM允许定义多个类型的条件。每一条件类型包含若干具体条件。

CCT数据模块分为三个部分：条件常用类型的定义（元素<condTypeList>）、特定條件的定义（元素<condList>）、技术条件合并状态清单（元素<incorpor-ation>）。

CCT数据模块的顶层结构图如图2所示。

条件类型如服务通告，可根据需求定义具体的条件。

PCT数据模块

PCT数据模块是定义产品实例的数据存储库，并指定每个产品实例对应的产品属性值和条件取值。PCT数据模块中，对产品实例的定义包括一系列产品属性和条件的实际取值。每部分取值必须包含以下三部分信息（在元素<productCrossRefTable>＼<<product>＼<assign>中）：

对产品属性或条件的参引，属性“app-licPropertyIdent”，来自ACT和CCT中的属性ID，如：“model”。产品属性或条件的标识，属性“applicPropertyType”，“prodattr”表示产品属性，“condition”表示条件。实际取值：属性“applicProper-tyValue”，来自ACT或CCT。

PCT数据模块的顶层结构图如图3所示。

PCT DM内容组合的示例：

表示：

XXX型号，序列号为045，MSN为0705，执行XXX-32-SB070后;

XXX型号，序列号为039，MSN为0610，执行XXX-32-SB120前。

三类适用性数据模块之间的关系

ACT、CCT、PCT三类数据模块是以ACT为中心点实现三者的关联，可以确保引用的适用性准确、规范。所有需要适用性过滤的数据模块、发布模块都必须通过标识和状态段参引ACT数据模块，参引关系如图4所示。

DM和PM参引ACT DM：

所有需要进行适用性过滤的DM和PM必须通过标识和状态段的<applicCross-RefTableRef>参引到同一ACT数据模块。从数据模块到ACT的单向参引，ACT与CCT间的双向参引，ACT与PCT间的双向参引，如图5所示。

飞机技术出版物适用性注释规则

飞机技术出版物适用性注释的对象

在出版物内容中须标注适用性的对象包括：数据模块（DM），包括整个DM级别的适用性和DM中局部内容的适用性;技术插图，某幅插图的适用性;出版物模块（PM），发布的PM适用性，主要指PM适用的客户、飞机架次等。

在数据模块中适用性注释级别的原则：根据出版物使用对象设置适用性。确保数据唯一性，尽量在较低的内容级别标注适用性。如，某维修程序中仅某个步骤有适用性差异，那么适用性应标注在该步骤，而非整个DM，以避免重复性信息。

在数据模块中，适用性注释应用于以下两个级别：整个DM级别，标识和状态段的<applic>;DM中的部分内容，标识和状态段的<referencedApplicGroup>＼<applic>。

适用性在数据模块中的表述方法

（1）数据模块级别的适用性标注

在标识和状态段中直接定义<applic>元素时，指示整个数据模块的适用性。表示方法为：

<displayText>Model XXX </displayText>

</applic>

（2）数据模块内容的适用性标注

在标识和状态段的<referencedApplic-Group>中定义<applic>时，指示数据模块内部局部内容的适用性。在数据模块内部需要指明部分内容的适用性时，应当使用内容元素的applicRefId属性，引用到<referencedApplicGroup>中的某个<applic>上。表示方法为：

在<referencedApplicGroup>定义适用性表达式：

<displayText> Model XXX</displayText>

<assert applicPropertyIdent=”model”

applicPropertyType=”prodattr”

applicPropertyValues=”XXX” />

</applic>

<displayText>ModelXXX0</displayText>

<assertapplicPropertyIdent=”model”

applicPropertyType=”prodattr”

applicPropertyValues=”XXX” />

</applic>

</referencedApplicGroup>

在内容中引用所需的適用性表达式：

<title>Title</title>

</proceduralStep>

<title>Title</title>

</proceduralStep>

</mainProcedure>

（3）数据模块中适用性注释方法

①适用性元素<applic>的注释方法

在创建一个数据模块时，应根据源数据要求在数据模块的元素<applic>中编写适用性注释。当源数据出现变化引起数据模块的适用性变化时，元素<applic>应相应更新。

适用性元素<applic>提供了两种适用性注释方法（即两个分支）：可阅读的注释（human readable）分支、可计算的注释（computer processing）分支。

可阅读注释（自然语言）提供了可读适用性说明，由<displayText>表示。可阅读适用性注释用于纸质出版物以及内容的静态展示。通过这种方式，用户可查看所有技术信息，并自行阅读各类适用性注释并决定其所需内容。这一方式无需适用性模型（即ACT、CCT和PCT数据模块），无须支持客户化发布，对适用性注释的计算机处理部分也不作要求。

示例：

<simplePara>适用于XXX</simplePara>

</displayText>

可计算的注释为计算机处理提供了可计算格式的适用性注释，由<assert>或<evaluate>表示。适用性注释的计算机处理用于支持过滤后展示或客户化发布。适用性注释仍须以自然语言形式展示给终端用户。

示例：

<displayText><simplePara>SN： 001-002， 005-010 simplePara></displayText>

<assert applicPropertyIdent=”serialno”

applicPropertyType=”prodattr”

applicPropertyValues=”001～002|005～010”/>

</evaluate>

</applic>

②出版物模块与插图的适用性