T/SHJMRH 0010-2022 产品交互式电子技术手册展现要求

ICS35.240.50

CCSL72

团体标准

T/SHJMRH0010—2022

产品交互式电子技术手册展现要求

ProductInteractiveElectronicTechnicalPublicationPresentationRequirements

2022-07-15发布2022-08-01实施

上海市军民融合发展研究会发布

T/SHJMRH0010—2022

目次

前言...........................................................................II

1范围................................................................................3

2规范性引用文件......................................................................3

3术语和定义..........................................................................3

4展现基本要求........................................................................3

4.1概述............................................................................3

4.2屏幕版式........................................................................3

4.3导航面板........................................................................5

4.4样式和格式......................................................................6

4.5对话框..........................................................................6

4.6列表............................................................................7

4.7步骤............................................................................7

4.8表格............................................................................7

4.9超链接..........................................................................8

4.10警告和注意.....................................................................8

4.11改变标记.......................................................................9

4.12缩略语.........................................................................9

4.13图示—图.......................................................................9

4.14IETP打印输出...................................................................9

5功能矩阵............................................................................9

5.1概述............................................................................9

5.2功能类别.......................................................................10

5.3引用...........................................................................10

5.4矩阵栏.........................................................................10

6功能定义...........................................................................11

6.2访问...........................................................................11

6.3注释...........................................................................11

6.4传输和发布.....................................................................13

6.5诊断和预测.....................................................................13

6.6外部过程.......................................................................15

6.7图形功能.......................................................................16

6.8连接...........................................................................17

6.9导航和跟踪.....................................................................18

6.10打印..........................................................................20

6.11特殊内容......................................................................20

6.12升级..........................................................................21

6.13用户使用模式..................................................................22

I

T/SHJMRH0010—2022

前言

本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定

起草。

本文件由上海市军民融合发展研究会提出并归口。

本文件起草单位：中国电子信息产业集团有限公司中电长城网际系统应用有限公司、上海智行砺德

众创空间管理有限公司、上海市军民融合发展研究会、上海精密计量测试研究所、上海华融机电设备保

障技术研发中心、上海栖云航空科技有限公司、上海申武信息科技有限公司。

本文件主要起草人：孟燕雨、杨波、徐文胜、吴晋娜、翟文蓉、聂文琪、王凌、李楠、孙丽云、桑

军、尹滨、黄挥挥、刘运峰。

II

T/SHJMRH0010—2022

产品交互式电子技术手册展现要求

1范围

本标准规定了产品交互式电子技术手册展现的基本要求和功能要求，给出了查看、体验和从IETP

打印输出的规则和建议。

本标准适用于产品交互式电子技术手册的研发、使用和维护等。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，

仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本

文件。

GB/T24463（所有部分）交互式电子技术手册

GJB6600（所有部分）装备交互式电子技术手册

S1000DIssue5.0基于公共源数据库的技术出版物国际规范（Internationalspecificationfor

technicalpublicationsusingacommonsourcedatabase）

T/SHJMRH0004-2022产品交互式电子技术手册数据模块基础数据要求

3术语和定义

GB/T24463、GJB6600界定的以及下列术语和定义适用于本文件。

4展现基本要求

4.1概述

4.1.1本节给出了查看、体验和从IETP打印输出的指南。

4.1.2每个项目可以自行决定使用本节中的哪些元素以满足产品和终端用户的需求。本标准可用于以

构建项目需求。

4.1.3由于显示技术总是在不断变化（如终端、台式电脑、笔记本、个人电子辅助设备）。因此，在

规范阶段适应当规划各种设备的大小和分辨率。

4.1.4样式表很有必要，因为它能够将XML数据模块转换为IETP可以解释并加以显示的格式。

4.2屏幕版式

4.2.1屏幕由一个框架、标题栏和内部栏组成，见图1。

4.2.2框架是应用/浏览器窗口，是环绕标题和内部栏的屏幕部分。

3

T/SHJMRH0010—2022

图1屏幕布局应用

4.2.3水平标题栏必须位于框架的顶部，标题栏可包含应用的名称，也可包含安全等级标记、数据模

块代码、以及当前浏览的数据模块标题。

4.2.4内部框架式是IETP的一部分，用于提供主要显示区域。

4.2.5内部框架至少应包含内容目录（TOC）面板、导航面板和主内容区域，如图2所示。作为可选

项，还可以包含重置区域。

图2内部框架组成

4.2.6目录区位于主内容区域的左边，是进行导航交互的区域，见图2，该区包括：

‒所有关键输入点的列表或清单（如出版物和数据模块）用户可访问。可以通过层次性分解提供：

•将出版物集合分解为多个出版物；

•将出版物分解为多个数据模块，如SNS结构。

‒须包含突出显示的数据模块，以便用启用提供状态信息，以及升级出版物和数据模块的变更原

因。

4

T/SHJMRH0010—2022

‒其他导航，例如：

•表目录；

•图目录。

4.2.7这些可通过图形接口来实现。

4.2.8该区的大小必须可变，并能够固定或移动。

4.2.9重置区域允许用户将IETP显示回退到默认设置。重置区域同样为导航和优先权提供了特殊机制。

在此区域中通过使用功能菜单提供列项。例如，重置区域提供菜单，用户可以不同的方式浏览IETP，

如通过零件号、图列表、修订、摘要等。重置区域可固定或可移动，但必须保证可访问性。若可移动，

须保证重置区域易于被用户找到，若不通过诸如罗盘的图标或右击菜单来实现。点击区域可提供一个功

能菜单。

4.2.10重置区域同时也提供了选择用户偏爱的方法。重置区域菜单包括允许用户固定或移动屏幕区

域的选择项，此类屏幕的示例是额外的信息栏。若不允许用户移动特定屏幕区域，建议将相应的菜单选

项显示为灰色不可用。

4.3导航面板

4.3.1导航面板由多栏组成，各栏组成，各栏的顺序如下：

1子标题栏（O，可选）；

2主菜单栏（M，强制）；

3额外信息栏（O，可选）。

4.3.2导航栏既可出现在主内容区域上面，也可出现在下面。在应用中，导航栏面板的位置须尽可能

的保持一致。

4.3.3录源标识和状态部分的信息未被显示在标题栏时，子标题栏可用于显示这些额外信息，如修改

状态或等级。

4.3.4主菜单栏包括一组基本功能。若项目需要，可批准这些功能（或任何功能组合）。标准功能的

表达有三种方式：

‒基于文本：此功能给出文本标签；

‒基于图形：此功能由图标表达；

‒文本和图形：图标和文本组合使用。

主菜单栏包含图3所展示的功能。

图3导航面板-示例

4.3.5当使用时，图标应可以反映其所执行的功能，其意思应清晰明确避免用户混淆。由于需要在确

定最终集合之前考虑终端用户和操作环境，所以图标在此未颁布。这与本章前面所述的基本功能相关，

只是增加了一些图标，以为将来扩展之用。

4.3.6层叠菜单可作为所选功能的子部分，在下接菜单中，其紧挨着所选功能。可有多层层叠菜单。

4.3.7处理过程中未用到的功能须显示为不可用。但标题栏须可用。

4.3.8上一步，通过数据引导用户以顺序方式后退。

4.3.9下一步，通过数据引导用户以顺序方向前进。

4.3.10锁定或移动目录TOC面板的功能。

4.3.11以顺序方式显示先前访问的数据的导航功能（如已访问听数据模块）。

4.3.12显示搜索对话框的功能。

4.3.13允许打印数据的功能（如通过使用打印对话框）。依据决策，若信息为保密级，可禁用打印功

能，打印按钮显示为灰色。

4.3.14允许从用户获得针对单个数据模块、出版物或整个出版物集合的反馈的功能。可通过例如使用

意见模式来实现。

5

T/SHJMRH0010—2022

4.3.15允许从IETP退出的功能，若合适，可采用下述模式：

‒完全退出：退出应用；

‒暂停退出：暂时中止用户使用。

4.3.16显示帮助文件的功能，帮助可包含浏览器使用信息。

4.3.17显示数据模块或出版物部分或全部标识状态信息的功能。

4.3.18基需要附加功能，可使用附加信息栏（如订购备件）。附加信息栏位于主菜单栏下，且必须包

括绑定和脱绑功能。

4.3.19主内容区域包含IETP的技术内容、文本和图形信息，该区域分割时不能超过三块。

4.3.20屏幕堆叠就是使用多个窗口，须避免发生此现象以保证终端用户的清楚使用。

4.4样式和格式

4.4.1除非本章另有说明，所用的样式和格式须符合打印的通用原理。

4.4.2须考虑显示设备的显示能力，建议针对最低配置显示设备（8-bit，单色设备等）进行设计。通

过人素研究或可用性测试来控制颜色的使用。使用环境和所用设备须规定与所用颜色相关的规则，还须

考虑操作条件如夜间操作、红光条件以及颜色有特殊意义的情况。

4.4.3标准的文本显示，推荐的颜色模式是白底黑字。

4.4.4确定字体和字号时，须考虑打印的详细信息，所使用的字号必须保证读者可以读取技术内容，

并须关注显示设备和工作环境。

4.5对话框

4.5.1对话框可以从用户获取信息并给用户提供反馈，若可能，须在屏幕中央显示。对话框在整个IETP

中须保持一致。

4.5.2对话框可以包含控件，用户通过命名控件对话框进行交互。典型控件包括：

‒文本输入框；

‒按钮；

‒复选框；

‒单选按钮；

‒列表框。

4.5.3控制件可有提示，提示展示关于控件目的的更多信息。用户把鼠标放在控件上方时，便会出现

提示。参见图4，其中展示了包含各种类型的命名控件和提示的对话框示例。

图4对话框-示例

4.5.4文本输入框允许终端用户以文本和数字的形式提供应用信息。

4.5.5若可能，数据输入区域提示与数据登记区域置于同一行中。提示的格式化必须不同，并尽可能

位于数据登记区域附近。