产品交互式电子技术手册程序类数据模块数据要求(T-SHJMRH 0006—2022).pdf

ICS 35.240.50 CCS L 72 团体标准 T/SHJMRH 0006-2022 产品交互式电子技术手册程序类数据模块数据要求 Product Interactive Electronic Technical Publication Procedural Information Data Module Requirements 2022-07-15 发布 2022-08-01 实施 上海市军民融合发展研究会 发 布 T/SHJMRH 00062022 I 目 次 目次.I 前言.II 1 范围.1 2 规范性引用文件.1 3 术语定义.1 4 基本规则及图例.1 5 数据要求.2 5.1 概述.2 5.2 程序类信息.2 附录 A（资料性）示例.9 T/SHJMRH 00062022 II 前 言 本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。本文件附录A为资料性附录。本文件由上海市军民融合发展研究会提出并归口。本文件起草单位：上海市军民融合发展研究会、中国电子科技集团公司第五十研究所、上海航天电子有限公司、上海精密计量测试研究所、上海华融机电设备保障技术研发中心、上海栖云航空科技有限公司、上海申武信息科技有限公司。本文件主要起草人：聂文琪、詹菲、钱婧怡、汪伟岚、邓智青、王永杰、李楠、朱大兴、吴晋娜、翟文勇、孙丽云、桑军、尹滨、黄挥挥。T/SHJMRH 00062022 1 产品交互式电子技术手册程序类数据模块数据要求 1 范围 本标准规定了产品交互式电子技术手册的程序类数据模块基本规则及图例、数据要求。本标准适用于产品交互式电子技术手册的研发、使用和维护等。2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 24463（所有部分）交互式电子技术手册 GJB 6600（所有部分）装备交互式电子技术手册 S1000D Issue 5.0 基于公共源数据库的技术出版物国际规范（International specification for technical publications using a common source database）T/SHJMRH 0004-2022 产品交互式电子技术手册数据模块基础数据要求 3 术语定义 GJB 6600-2008、GB/T24463-2009确立的术语和定义适用于本标准。4 基本规则及图例 数据模块由状态与标识部分、内容部分组成，其中状态与标识部分各种类型数据模块具有相同的数据要求，内容部分随数据模块的不同而各异。基本规则如下：用表示元素，如表示“内容”元素；用斜体宋体字符来表示属性，如：版本类型 属性；用(O)表示可选项；用(M)表示必选项。表1 图例 符号 说明 强制的顺序分支。包含的元素（如果有）应在连接符号分支中顺序列出。T/SHJMRH 00062022 2 可选且可重复的顺序分支。包含的元素应在连接符号分支中顺序出现。强制的选择分支。在定义的选择分支中，有且只有一个分支允许被选择。可选且可重复的选择分支。允许从定义的选择分支中选择 0 个以上任何顺序排列的分支。强制且可重复的选择分支。允许从定义的选择分支中选择 1 个以上任何顺序排列的分支。5 数据要求 5.1 概述 程序模式用于捕获和表示过程信息。维护程序数据模块的粒度应遵循 SNS 和信息代码反映的细分，并且应反映维护计划中确定的任务。机组/操作员程序数据模块的粒度应遵循 SNS 和信息代码反映的细分，并且应反映所识别的操作。应使用 T/SHJMRH 0004-2022产品交互式电子技术手册数据模块基础数据要求中所述的公共实体、元素和属性。5.2 程序类信息 5.2.1 模式基本规则 程序类模式具有结构化元素用于提供层次性步骤和子步骤。如果一个条件（例如，警告、注意和/或安全）适用于一个步骤或子步骤，则该条件也适用于其所有子步骤。程序类模式可用于所有程序类或教学类的信息类型。该模式包含各种元素的替代。5.2.2 内容 元素 程序类数据模块的内容部分。标记元素。见图1.T/SHJMRH 00062022 3 图 1 程序性数据模块内容的主要元素 属性信息如下：a)id(O)，标记元素的标识符，参见 T/SHJMRH 0004-2022。b)子元素：c)，参见 T/SHJMRH 0004-2022；d)，用于收集应用于数据模块各部分适用性注释的容器；e)，用于定义对应用于数据模块各个部分的外部化适用性注释的引用；f)，包含数据模块中使用的警告和警戒的集合。每个警告或警告都是在元素中单独编写的；g)，包含对警告或警戒的引用；h)，参见第 5.2.3 条。5.2.3 程序 元素 包含执行任务或执行程序类信息为目标所必需的全部信息。标记元素。图 2 元素 属性：无。子元素信息如下：T/SHJMRH 00062022 4 a)，参见 T/SHJMRH 0004-2022；b)，参见 T/SHJMRH 0004-2022；c)，参见第 5.2.4 条；d)，参见 T/SHJMRH 0004-2022。5.2.4 主要程序 说明：元素 包含要完成的详细程序步骤，用图、多媒体、插页和表格适当地辅助见图1。标记元素：。图 3 元素 属性信息如下：a)id(O)，标记元素的标识符，参见 T/SHJMRH 0004-2022；b)changeType(O)、changeMark(O)和 reasonForUpdateRefIds(O)，更改指示，参见 T/SHJMRH 0004-2022；c)skillLevelCode(O)，全部程序所需的技能等级，参见 T/SHJMRH 0004-2022。属性skillLevelCode 可以有下列值：d)“sk01”到“sk99”。e)independentCheck(O)，全部程序应由指定资格的监管人员来检查；f)securityClassification(O)、commercialClassification(O)、caveat(O)和derivativeClassificationRefId(O)，安全和限制性标记。子元素：T/SHJMRH 00062022 5 a)，参见第 5.2.4.1 条；b)，参见第 5.2.4.2 条；c)，参见 T/SHJMRH 0004-2022；d)，参见 T/SHJMRH 0004-2022；e)，参见 T/SHJMRH 0004-2022；f)，参见 T/SHJMRH 0004-2022；g)，参见 T/SHJMRH 0004-2022；h)，参见 T/SHJMRH 0004-2022。5.2.4.1 程序步骤 说明：元素包含程序里的一个步骤。一个步骤可以通过包含另一个元素(或)来分解为子步骤，子步骤自身也可以包含另一个元素(或),进一步分解为子步骤，如此等。以这种方式，任何子步骤分解的深度都能实现。但不建议超过5级深度，决不能超过8级深度。见图2。标记元素：。T/SHJMRH 00062022 6 图 4 元素 属性信息如下：a)applicRefId(O)，引用元素的适用性信息；b)id(O)，标记元素的标识符，参见 T/SHJMRH 0004-2022；c)changeType(O)、changeMark(O)和 reasonForUpdateRefIds(O)，更改指示，参见 T/SHJMRH 0004-2022；T/SHJMRH 00062022 7 d)warningRefs(O)，警告和注意集中警告的引用；e)cautionRefs(O)，警告和注意集中注意的引用；f)independentCheck(O)，此步骤应检查(例如，由有资格的监管人员)；g)skillLevelCode(O)，该程序步骤所需的技能等级，参见 T/SHJMRH 0004-2022。属性skillLevelCode 可以有下列值：h)“sk01”到“sk99”。i)keepWithNext(O)，如果可能，是否一个步骤与下一步骤同时出现，属性 keepWithNext 只在给定条件下绝对必需时才使用（例如，滚动无法实现或浏览器不允许滚动）。属性 keepWithNext可以有下列值：j)“0”(D)-否，步骤和接下来的同级步骤不在一起；k)“1”-是，步骤和接下来的同级步骤不在一起（如果存在的话），因此设置属性 keepWithNext的元素的所有子元素也保持在一起（如果可能的话）。属性 keepWithNext 对于最后一个步骤没有意义。l)itemCharacteristic(O)，用于给出指定程序步骤主题的项目特性。如果使用的话，属性itemCharacteristic 可以有一个或多个以下值：m)“ic01”到“ic99”。n)authorityName(O)和 authorityDocument(O)，受控内容指示，参见 T/SHJMRH 0004-2022；o)securityClassification(O)、commercialClassification(O)、caveat(O)和derivativeClassificationRefId(O)，安全和限制性标记。子元素信息如下：a)，标题的使用，参见第 5.2.4.3 条。标题的一般规则，参见 T/SHJMRH 0004-2022；b)，警告的验证，参见第 5.2.4.4 条。警告的一般规则；c)，注意的验证，参见 5.2.4.4 条。注意的一般规则；d)，注释；e)，参见 T/SHJMRH 0004-2022；f)，参见 T/SHJMRH 0004-2022；g)，参见 T/SHJMRH 0004-2022；h)，参见 T/SHJMRH 0004-2022；i)，参见 T/SHJMRH 0004-2022；j)，参见 T/SHJMRH 0004-2022；k)，参见 T/SHJMRH 0004-2022；l)，参见 T/SHJMRH 0004-2022；m)，参见 T/SHJMRH 0004-2022；n)；o)，参见第 5.2.4.2 条。注：该模式允许使用于单个子步骤。5.2.4.2 程序步骤备用组 说明：元素是一个备用组，其提供把一个步骤的几个备用组合在一起的能力。标记元素：。属性信息如下：a)id(O)，标记元素的标识符。参见 T/SHJMRH 0004-2022；T/SHJMRH 00062022 8 b)changeType(O)、changeMark(O)和 reasonForUpdateRefIds(O)，更改指示，参见 T/SHJMRH 0004-2022；c)altsName(O)，替代组名称；d)authorityName(O)和 authorityDocument(O)，受控内容指示，参见 T/SHJMRH 0004-2022；e)securityClassification(O)、commercialClassification(O)、caveat(O)和derivativeClassificationRefId(O)，安全和限制性标记。5.2.4.3 标题 说明：元素 用于给出步骤或子步骤序列的标题。元素应始终如一地用于一个程序中。以下规则是适用的：a)如果任何一个同级步骤有标题该步骤应有标题；b)如果其父步骤有标题该步骤可以有标题。5.2.4.4 警告、注意和注释 放在一个步骤（元素）中的警告、注意或注释，或警告或注意的引用适用于它的所有子步骤（元素）。T/SHJMRH 00062022 9 附录 A（资料性）示例 附 A.1 不使用替代概念 不使用替代概念的程序标记示例如下：The bicycle is outdoors Bike cleaner 1,0 Bike rider 1,0 Water hose KZ666 BSK-TLST-001-09 1 Stiff bristle brush KZ666 BSK-TLST-001-02 1 Sponge T/SHJMRH 00062022 10 KZ666 BSK-TLST-001-11 1 Degreasing agent KZ222 LL-004 1 Detergent A KZ666 BSK-TLST-023-14 1 Detergent B KZ666 BSK-TLST-001-15 1 Do not get into your eyes.If it gets into your eyes,wash them immediately in clean warm water.Do not get into your eyes.If it gets into your eyes,wash them immediately in clean warm water.Do not use a that has high pressure.A water hose that has high pressure can cause some parts to become loose or full of water.Do not point the hose directly at the hub or at the bottom bracket bearings.This can cause damage to the parts.Apply T/SHJMRH 00062022 11 in accordance with the instruction on the container.The substance may cause damage to the Bike paint if it is not applied correctly.Clean the bicycle with water to remove all dirt.Refer to .Cleaning the bike Use a to get access to areas that are not easy to clean.These are the shift levers,the knobbly tires,and the brakes.Clean the caked grime from the chain and the sprockets with a screwdriver that has a small blade.Remove the grease from the freewheel assembly with the as shown in .Use a brush to remove the grease from these parts:sprockets guide and tension wheels of the derailleur chain ring teeth Degreasing the freehub Flush the sprockets,the derailleurs,the chain rings and the chain with water.If necessary,do the flush procedure again.Wash the Bike Soak the into and water.Clean the bicycle with the soaked sponge.Flush the bicycle and make sure that all is removed.Move the bicycle up and down on its tires to remove all water.T/SHJMRH 00062022 12 Wash the BikeSoak the into and water.Clean the bicycle with the soaked sponge.Soak the into and water.Fully clean the bicycle with the soaked sponge.Flush the bicycle to make sure that all detergents are removed.Move the bicycle up and down on its tires to remove all water.Lubricate the bicycle(refer to).Make sure the bicycle is dry 附 A.2 使用替代概念 使用替代概念的程序的标记示例如下：Clean the bicycle with water to remove all dirt.Refer to.Cleaning the bike Use a to get access to areas that are not easy to clean.These are the shift levers,the knobbly tires,and the brakes.Clean the caked grime from the chain and the sprockets with a screwdriver that has a small blade.Remove the grease from the freewheel assembly with the as shown in .Use a brush to remove the grease from these parts:sprockets guide and tension wheels of the derailleur chain ring teeth Degreasing the freehub Flush the sprockets,the derailleurs,the chain rings and the chain with water.If necessary,do the flush procedure again.Wash the Bike Soak the into and water.Clean the bicycle with the soaked sponge.Flush the bicycle and make sure that all is removed.Move the bicycle up and down on its tires to remove all water.Wash the Bike Soak the into and water.Clean the bicycle with the soaked sponge.Soak the into and water.Fully clean the bicycle with the soaked sponge.Flush the bicycle to make sure that all detergents are removed.Move the bicycle up and down on its tires to remove all water.Lubricate the bicycle(refer to).T/SHJMRH 00062022 14 _