产品交互式电子技术手册数据模块基础数据要求(T-SHJMRH 0004—2022).pdf
《产品交互式电子技术手册数据模块基础数据要求(T-SHJMRH 0004—2022).pdf》由会员分享,可在线阅读,更多相关《产品交互式电子技术手册数据模块基础数据要求(T-SHJMRH 0004—2022).pdf(205页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、ICS 35.240.50 CCS L 72 团体标准 T/SHJMRH 0004-2022 产品交互式电子技术手册数据模块基础数据要求 Product Interactive Electronic Technical Publication Data Module Common Requirements 2022-07-15 发布 2022-08-01 实施 上海市军民融合发展研究会 发 布 T/SHJMRH 00042022 I 目 次 前言.III 1 范围.1 2 规范性引用文件.1 3 术语定义.1 4 基本规则及图例.1 5 状态与标识部分数据要求.2 5.1 概述.2 5.2 标
2、识部分.3 5.3 状态部分.7 6 通用结构-更改标记.27 6.1 概述.27 6.2 一般规则.27 6.3 更新原因.27 6.4 修改原因.28 6.5 对文本进行更改.30 6.6 在表格中标注更改的特殊规则.32 6.7 标记数字变化的特殊规则.37 6.8 表明警告和注意事项变化的特殊规则.39 7 通用结构引用.40 7.1 概述.40 7.2 引用的使用.40 8 通用结构列表.60 8.1 概述.60 8.2 列表.61 8.3 示例.65 9 通用结构说明文字组.67 9.1 概述.67 9.2 说明文字组标题.68 9.3 示例.74 10 通用结构标题.75 10.
3、1 概述.75 10.2 标题.76 10.3 示例.76 T/SHJMRH 00042022 II 11 通用结构表格.78 11.1 概述.78 11.2 表格.78 11.3 示例.88 12 通用结构图、多媒体和插页.91 12.1 概述.91 12.2 图、多媒体和插页.91 12.3 示例.96 13 通用结构热区.99 13.1 概述.99 13.2 内容.99 13.3 示例.104 14 通用结构准备工作需求和收尾工作需求.112 14.1 概述.112 14.2 准备工作需求.113 14.3 收尾工作要求.167 15 通用结构文本元素.169 15.1 概述.169 1
4、5.2 文本元素.172 16 通用结构受控内容.195 16.1 概述.195 16.2 受控内容.195 16.3 示例.195 17 通用结构公用信息.196 17.1 概述.196 17.2 公用信息.196 17.3 示例.198 18 通用结构外部化.199 18.1 概述.199 18.2 外部数据元素引用.199 T/SHJMRH 00042022 III 前 言 本文件按照GB/T 1.1-2020标准化工作导则 第1部分:标准化文件的结构和起草规则的规定起草。本文件由上海市军民融合发展研究会提出并归口。本文件主要起草单位:上海市军民融合发展研究会、上海精密计量测试研究所、中
5、国电子科技集团公司第五十研究所、中国船舶集团有限公司第七四研究所、上海航天电子有限公司、上海华融机电设备保障技术研发中心、上海栖云航空科技有限公司、上海申武信息科技有限公司。本文件主要起草人:刘运峰、朱大兴、詹菲、盛伟群、钱婧怡、赵崇卫、李楠、聂文琪、吴晋娜、王永杰、翟文勇、孙丽云、桑军、尹滨、黄挥挥。T/SHJMRH 00042022 1 产品交互式电子技术手册数据模块基础数据要求 1 范围 本文件规定了产品交互式电子技术手册的数据模块的基础数据要求。本文件适用于产品交互式电子技术手册的研发、使用和维护等。2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注
6、日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 24463(所有部分)交互式电子技术手册 GJB 6600(所有部分)装备交互式电子技术手册 S1000D Issue 5.0 基于公共源数据库的技术出版物国际规范(International specification for technical publications using a common source database)3 术语定义 GB/T 24463、GJB 6600-2008界定的术语和定义适用于本文件。4 基本规则及图例 数据模块由状态与标识部分、内容部分组成,其中状态
7、与标识部分各种类型数据模块具有相同的数据要求,内容部分随数据模块的不同而各异。各类型数据模块中重复出现的模块化数据块称为通用结构,常用的通用数据结构有:更改标记、引用、列表、说明文字组、标题、表格、图、多媒体和插页、热区、准备工作需求和收尾工作需求、文本元素、受控内容、公用信息和外部化13类。基本规则如下:a)用表示元素,如表示“内容”元素;b)用斜体宋体字符来表示属性,如:版本类型 属性;c)用(O)表示可选项;d)用(M)表示必选项。图例见表1。表1 图例 符号 说明 T/SHJMRH 00042022 2 强制的顺序分支。包含的元素(如果有)应在连接符号分支中顺序列出。可选且可重复的顺序
8、分支。包含的元素应在连接符号分支中顺序出现。强制的选择分支。在定义的选择分支中,有且只有一个分支允许被选择。可选且可重复的选择分支。允许从定义的选择分支中选择 0 个以上任何顺序排列的分支。强制且可重复的选择分支。允许从定义的选择分支中选择 1 个以上任何顺序排列的分支。5 状态与标识部分数据要求 5.1 概述 5.1.1 状态与标识部分给出了识别和控制数据模块的所有元素的信息。同时还对状态信息进行说明,包括密级、质量和技术状态,以及数据模块总体内容与适用性。5.1.2 元素包含数据模块的状态与标识信息,分为状态与标识两部分。5.1.3 标记元素为,见图 1。说明:参见第 5.2 条;参见第
9、5.3 条。图1 元素 5.1.4 属性无。5.2 标识部分 5.2.1 概述 T/SHJMRH 00042022 3 5.2.1.1 元素用于唯一标识数据模块以及支持数据模块的其他附加信息。5.2.1.2 标记元素为,见图 2。说明:参见第5.2.2 条;参见第5.2.3 条。图2 元素 5.2.1.3 属性无。5.2.2 数据模块标识 5.2.2.1 概述 5.2.2.1.1 元素用于对数据模块唯一标识。5.2.2.1.2 标记元素为,见图 3。说明:在数据模块代码、问题和工作号以及语言和国家/地区不足以形成通用唯一标识的情况下,附加参数建立数据模块的唯一标识。元素建立生产者唯一子域用于识
10、别。参见第5.2.2.2 条;参见第5.2.2.3 条;参见第5.2.2.4 条。图3 元素 5.2.2.1.3 属性无。5.2.2.2 元素数据模块代码 5.2.2.2.1 元素包含数据模块代码,并组成数据模块的唯一标识。所有数据模块都具备一个数据模块代码。数据模块代码提供4类高层次信息:T/SHJMRH 00042022 4 a)产品或产品的某一部分的标识,利用型号识别码、系统、差异码、SNS、分解码和分解差异码等对产品说明;b)利用信息代码和信息差异码对信息类型标识;c)利用对象信息适用码给出数据模块中的信息所适用的位置;d)对学习类数据模块的学习内容类型进行标识。建立数据模块代码需要数
11、据模块编码策略。5.2.2.2.2 标记元素为。5.2.2.2.3 属性如下:a)modelIdentCode(M),型号识别码或项目名称;b)systemDiffCode(M),系统差异码;c)systemCode(M),系统代码(SNS 的一部分);d)subSystemCode(M),分系统代码(SNS 的一部分);e)subSubSystemCode(M),分分系统代码(SNS 的一部分);f)assyCode(M),单元组件代码(SNS 的一部分);g)disassyCode(M),分解码;h)disassyCodeVariant(M),分解差异码;i)infoCode(M),信息码
12、;j)infoCodeVariant(M),信息差异码;k)itemLocationCode(M),对象信息适用码;l)learnCode(O),学习代码;m)learnEventCode(O),学习事件代码。5.2.2.2.4 子元素无。标记示例:维护数据模块的标记示例:训练数据模块的标记示例:5.2.2.3 语言 5.2.2.3.1 元素给出编写数据模块所采用的语言。5.2.2.3.2 标记元素为 5.2.2.3.3 属性如下:a)languageIsoCode(M),国际标准化组织(ISO)639 中给出的由两个字符。简化语言并利用与ISO639 类似但不冲突的编码形式编码。比如 lan
13、guageIsoCode=“sx”即为简化技术英语(ASDSTE100)编写的数据模块,而 languageIsoCode=“ra”为法语数据模块;b)countryIsoCode(M)。采用 ISO3166 的两个字符,说明使用该语言的国家。T/SHJMRH 00042022 5 5.2.2.3.4 子元素无。标记示例:下面的示例为默认语言书写的数据模块:下面的示例为简化技术英语用牛津英语书写的数据模块:下面的示例为法语书写的数据模块:下面的示例为德语书写的数据模块:下面的示例为德语书写的、最终使用对象为澳大利亚人数据模块:5.2.2.4 版本信息 5.2.2.4.1 元素 包含数据模块的版
14、本号。5.2.2.4.2 标记元素为。5.2.2.4.3 属性如下:a)issueNumber(M),数据模块的发行号。每个批准的数据模块问题都应分配一个递增的发行号,该数字模块代码唯一地标识该数据模块的实例。初始问题应使用值“001”进行编号,该值应随每个批准的数据模块版本递增;b)inWork(M),未发布数据模块的“工作”号。它可用于监控和控制项目中的中间草案。初始工作号设置为值“01”,并随着对未发布数据模块的每次更改而递增。5.2.2.4.4 子元素无。标记示例:下面的示例说明了属性 inWork 的使用。注:对于其中的每一个,请相应地设置元素的属性 issueType 的值。下面的
15、数据模块为草稿状态,第二版。第一次发行的数据模块。数据模块,首次对内容更改,并处于编辑状态。数据模块,进行第二次更改和发行。5.2.3 数据模块地址项 5.2.3.1 概述 5.2.3.1.1 元素 包含对数据模块标识的补充但不是唯一标识符的一部分的信息。5.2.3.1.2 标记元素为,见图 4。T/SHJMRH 00042022 6 说明:参见第5.2.3.2 条;参见第5.2.3.3 条;参见第5.2.3.3.2 条;参见第5.2.3.3.3 条。图4 元素 5.2.3.1.3 属性无。5.2.3.2 发布日期 5.2.3.2.1 元素 包含数据模块定义的发布日期。例如,这可以是输入日期(
16、即,发布到CSDB 日期),或交付的截止日期等。数据模块的每个问题,无论是最初编写,完全修改还是通过更改更新,都应 以 YYYYMMDD 的形式分配 ISO 8601 日历日期。5.2.3.2.2 标记元素为。5.2.3.2.3 属性如下:a)year(M),四位数字,发行年份;b)month(M),两位数字,发行月份;c)day(M),两位数字,发行日期。5.2.3.2.4 子元素无。5.2.3.3 数据模块标题 5.2.3.3.1 概述 5.2.3.3.1.1 元素 包含数据模块的标题。数据模块标题应赋予数据模块代码的产品标识和操作元素含义。参见第 10 章。5.2.3.3.1.2 标记元
17、素为。5.2.3.3.1.3 属性无。5.2.3.3.2 技术名称 5.2.3.3.2.1 元素给出了硬件或功能的名称。也就是说它应反映基于产品分解的系统、分系统或分分系统的信息。示例:a)飞机;b)起落架系统;T/SHJMRH 00042022 7 c)2 号液压蓄能器;d)三轴配平制动机构;e)维修。5.2.3.3.2.2 标记元素为 5.2.3.3.2.3 属性为 securityClassification,参见第 5.3.4 条。5.2.3.3.2.4 子元素无。标记示例:Steering 5.2.3.3.3 信息名称 5.2.3.3.3.1 元素 包含描述与已编写数据模块的产品相关
18、的信息类型的信息名称。建议使用信息代码短定义填充元素(对应于元素中的属性,请参阅 5.2.2.2 条)。如果保持信息代码的意义,项目可以决定将信息名称修改(或扩展)为更合适的名称。如果信息代码变量指示了变化(元素中的属性infoCodeVariant,请参见5.2.2.2 章),可以扩展信息名称以描述此变体。5.2.3.3.3.2 标记元素为。5.2.3.3.3.3 属性为 securityClassification,参见第 5.3.3 条。5.2.3.3.3.4 子元素无。标记示例:Description of how it is made 5.3 状态部分 5.3.1 概述 5.3.1.
19、1 元素 包含数据模块状态信息。5.3.1.2 标记元素为,见图 5。T/SHJMRH 00042022 8 图5 元素 T/SHJMRH 00042022 9 5.3.1.3 属性如下:a)id(O),标记元素标识符,参见 7 章;b)issueType(O),数据模块的发行状态,8 种可用值如下:1)“new”。对于经过批准并首次发行的数据模块,属性 issueNumber 为“000”,状态值为“001”,属性 issueType 值为“new”。2)“changed”。如果对数据模块进行更新,那么其属性 issueType 值为“changed”。3)“deleted”。如果对数据模块
20、进行删除,则认为是一种特殊的数据更新操作。数据模块自身不是物理上从 CSDB 中删除,而是将属性 issueType 值设置为“deleted”。4)“revised”。如果数据模块是彻底的更新,没有对元素和属性进行更改,则属性 issueType的值为“revised”。5)“Status”。如果仅仅是对数据块的状态与标识部分进行更新,那么属性 issueType 的值设置为“Status”。6)“rinstatestatus”。如果数据模块是对先前删除的数据模块的恢复,并且仅仅对状态与标识部分进行更改,则属性 issueType 的值设置为“rinstatestatus”。最简单的情况,对
21、于状态的更改属性 issueType 的值为“rinstatestatus”。7)“rinstatechanged”。是对先前删除的数据模块的恢复,并且对其内的元素和属性做了修改,则属性 issueType 的值设置为“rinstate changed”。8)“rinstaterevised”。数据模块是对先前删除的数据模块的恢复,而所作的更改无法从元素和属性中反映出来,则属性 issueType 的值设置为“rinstate revised”。错误!未找到引用源。错误!未找到引用源。给出了属性issueType的可用值,其中“X”标识可以使用的值。表2 属性 issueType 的值 当前发
22、布 下个发布的值 new changed deleted revised status rinstatex new changed deleted revised status rinstatex 当刚刚开始一个数据模块的工作时,属性issueType的值为“new”,而版本号为“000”,编辑状态号为“01”,这两个值通过属性issueNumber和inWork表示。如果发行数据模块时,属性inWork重新置为“00”,并且通过该值反映数据模块的每次更新。从“002”开始,属性issueType的值就不能为“new”,而是用来反映数据模块的发行状态。实例如错误!未找到引用源。错误!未找到引用
23、源。所示。表3 属性 issueNumber、inWork 和 issueType 规则 编号 规则 属性值 00001 新数据模块,第一个工作版本,状态属性 issueType=new inWork=01 issueNumber=000 issueType=new 00002 新数据模块,第二个工作版本,状态属性 issueType=new inWork=02 issueNumber=000 issueType=new T/SHJMRH 00042022 10 000NN 新数据模块,工作版本NN,状态属性 issueType=new inWork=NN issueNumber=000 is
24、sueType=new 00100 第一期数据模块,状态属性issueType=new inWork=00 issueNumber=001 issueType=new 00101 第一期数据模块,第一个工作版本,状态属性 issueType=new inWork=01 issueNumber=001 issueType=new 00102 第一期数据模块,第二个工作版本,状态属性 issueType=new inWork=02 issueNumber=001 issueType=new 001NN 第一期数据模块,工作版本NN,状态属性 issueType=new inWork=NN issu
25、eNumber=001 issueType=new 00200 第二期数据模块,状态属性(例如)issueType=changed inWork=00 issueNumber=002 issueType=changed 5.3.1.4 子元素如下:a),参见第 5.3.2 条;b),参见第 5.3.3 条;c),参见第 5.3.4 条;d),参见第 5.3.5 条;e),参见第 5.3.6 条;f),参见第 5.3.7 条;g),参见第 5.3.8 条;h),参见第 5.3.9 条;i),参见第 5.3.10 条;j),应用;k),参见第 18 章;l),参见第 5.3.11 条;m),参见条
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 产品交互式电子技术手册数据模块基础数据要求T-SHJMRH 00042022 产品 交互式 电子技术 手册 数据 模块 基础 要求 SHJMRH 0004 2022
限制150内