核电厂交互式电子技术手册（IETM）第6部分：技术手册内容编制.docx

ICS27.120.01CCSP61T/CEPPC中国电力发展促进会团体标准TCEPPCxxxx-xxxx核电厂交互式电子技术手册(IETM)第6部分：技术手册内容编制Interactivee1ectronictechnica1manua1fornuc1earpowerp1ants-Part6:Technica1manua1contentpreparation（征求意见稿）在提交反馈意见时，请将您知道的相关专利连同支持性文件一并附上。XXXX-XX-XX发布XXXX-XX-XX实施中国电力发展促进会发布目次前言II1范围12规范性引用文件13术语和定义14缩略语15概述16编制要求2本文件按照GB/T1.1-2023标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。核电厂交互式电子技术手册(IETM)共由6部分组成：第1部分：总则；第2部分：数据编码；第3部分：数据管理；第4部分：数据模块编制；第5部分：功能及界面；第6部分：技术手册内容编制。本部分是核电厂交互式电子技术手册(IETM)的第6部分。本文件由中国电力发展促进会提出。本文件由核工业标准化研究所归口。本文件起草单位：中国核电工程有限公司、核工业计算机应用研究所、核工业标准化研究所、福建福清核电有限公司、国核中央研究院。本文件主要起草人：苗壮、徐钊、张楠、孙涛、李力、吴通、高超、刘勇、张亮、王德营、邓瑞源、唐志尧、吴飞飞、彭将、蒙堆强、李晶。核电厂交互式电子技术手册(IETM)第6部分：技术手册内容编制1范围本文件规定了用于核电厂交互式电子技术手册制作的技术文档的类别、文档结构、包含内容等总体要求。本文件适用于核电厂交互式电子技术手册的研发、使用和维护等。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。ASDS1OOOD基于公共源数据库的技术出版物国际规范3术语和定义下列术语和定义适用于本文件。3. 1交互式电子技术手册Interactivee1ectronictechnica1manua1(IETM)以数字形式存储，采用文字、图形、表格、音频和视频等形式，以交互方式提供核电厂基本原理、操作使用和维修等内容的技术出版物。3.2机组级mu1tisystem1eve1指核电厂内，完成特定主体功能的多个相互配合的工艺系统的集合。3.3系统级system1eve1指单个工艺系统所包含的软硬件设备的集合，如循环水系统。3.4设备级equipment1eve1具备某项单一功能的单体设备，如循环水泵。3.5速查手册QuickQuerymanua1指专用于将机组级和系统级技术手册的相关章节按照SR、TSR等条款编号进行汇总的IETM专用手册，以方便用户快速查阅不同手册中的相关技术内容，其中机组级主要包括技术规格书、技术规格书依据、厂内技术要求、厂内技术要求依据、其他技术要求、其他技术要求依据、定期试验技术要求、定期试验规程、总体运行规程、事故运行规程等；系统级主要包括系统设计手册、系统报警手册等。4缩略语下列缩略语适用于本文件。IETM:交互式电子技术手册(IntCraCtiVee1ectronictechnica1manua1)IETP:交互式电子技术出版物(InteraCtiVeE1ectronicTechnica1Pub1ication)适用于核电厂交互式电子技术手册机组级、系统级和设备级技术资料编制。6编制要求6.1 技术手册项目分类技术手册项目分类及代号如表1所示。表1技术手册项目分类表类别代号名称机组级01技术规格书02技术规格书依据03其他技术要求04其他技术要求依据05厂内技术要求06厂内技术要求依据07总体运行规程08事故运行规程09定期试验技术要求系统级10系统设计手册11系统故障手册设备级12技术说明书13维修手册14使用手册IETM15速查手册6.2 技术手册编制要求6.2.1技术手册的构成与格式技术手册一般由下列内容组成：a）封面,技术手册应设置封面。b）签署页,技术手册应设置签署页。c）文件更改记录，更改记录应填写手册的更改状况和历史，包括版本、发布日期、章节、页码、修改内容概要等内容。d）目录,超过5页的技术手册应设置目录页，目录应放在正文的前面。e）正文,正文是技术手册的主体部分，正文的内容和层次划分应按各项技术手册的具体要求编写。f）附录,附录作为正文内容的补充，放在正文内容之后，用附录A、附录B顺序编排（不用字母I、O）o6.2.2正文编制6. 2.2.1一般要求正文编制的一般要求如下：a）内容应简单明了、正确、完整、协调；数据准确；文实相符；b）材料、标准、成品型号和元件符号等必须采用现行国标、部标或企标；c）用户资料中含义相同的名词、术语应始终保持一致；d）进口机载设备资料中的厂商名称、地名、人名可不译成中文，照抄原文即可。7. 2.2.2语法、修辞和逻辑正文编制的语法、修辞和逻辑要求如下：a）要注意语法修辞和逻辑，词语搭配准确恰当，文字精练，文理通顺，结构严谨，浅显易懂；b）上、下文应保持统一、协调。采用数据模块语言表达完全相同的内容，即在同一手册的不同章节或在不同的手册中，在叙述同一设备（或部件、组件和元件等）的性能、安装、拆卸、维修等内容时要用完全相同的语言和文字来表达。8. 2.2.3人称和语气使用人称和语气时要求如下：a）第二人称命令式仅用于操作程序，例如，“检查外观有无损伤变形”；第二人称命令式不能用在主要划分和次主要划分中：b）在中文叙述中，不宜使用被动语态；c）第三人称应当用来进行说明论述，例如，“扭力杆组件将扭矩从轴传到减震支柱上”。9. 2.2.4术语和缩写词术语和缩写词的要求如下：a）在所提供的全部技术手册中，术语和缩写词应当前后一致，亦应和核电机组或设备上的标牌、标志等一致。所采用的术语和缩写词应当容易理解，使用广泛，且只能有一种含义；b）缩写词应当规范统一。10. 2.2.5标题确定标题时要注意：a）正文中的标题应当紧扣内容，以简明的叙述性短语或词指明所论述的主题和要执行的功用。程序步骤和正文的进一步划分都应当用第二人称命令式主动语态叙述。例如，当论述指定的工作功用时，可用“更换传感器”、“检查XX系统的工作”等；b）设备的全名应当在手册的标题中表示出来。如果全名可以采用通用缩写词，那么这个缩写词在文中第一次出现时用括号示出。在详细叙述中再引用这一设备时可以采用缩写词。11. 2.2.6警告、注意和注警告、注意和注主要用于突出和强调正文中的重要事项。应慎重地使用这些提示，以保持这些术语的严肃性。a） “警告”一一是要在使用材料、过程、方法、程序或限制时引起注意，必须严格遵守这些条款，否则将造成人身事故。b） “注意”一一是对方法和程序的限制和要求，必须严格遵守这些条款，否则将损坏设备。c） “注”一一是对方法和程序的进一步说明，以使工作顺利完成。d） “警告”和“注意”及其条文应当直接放在与它有关的正文前面且采用明显的黑体字示出，并且要与它有关的步骤层次划分开头的数字或字母上下对齐。而“注”要直接放在与它有关的正文的后面，并且要与同它有关的正文上下对齐。“警告”、“注意”和“注”尽可能与它有关的正文放在同一页上或相邻的页上。6.2.2.7表表格应按以下要求编排：a）文中的表均应安排在文中第一次提到该表的正文下面，并且在文中应有说明，如“见表X-X”；b）表格采用全封闭式，表格与上、下文衔接处要各空一行；c）表按章或节顺序编号，表序和表题居中书写，表序与表题之间空一格，表题末尾不加标点符号：d）如果表格需要转页接排时，接排的表，应在表的上方重复表的编号，并在编号后用“续”标明；e）表中量的名称、符号和单位的名称、符号应与正文一致。单位的名称或符号一般写在表头栏内，如全表单位统一，也可写在表格右上角，与表题在同一行加括号，右边空两格。若表格中的数字有“大于”、“小于”、“不大于”、“不小于”或“等于”等表述时，不要用文字书写，用符号表示；f）表中各栏有对应关系的数值一般应按小数点对齐；无对应关系的数值各自居中；无数值和无内容的格内一律空白；g）表中文字一般横写。若文字较多，需要回行书写时，应上、下文对齐，尽量紧凑。句中标点符号按正文的规定使用，段末不加标点。表中下行文字与上行文字、右格文字与左格文字相同时，应重复书写，不得使用”符号以及“同上”、“同左”等类似词。6.2.2.8公式公式应按以下要求书写：a）文中公式一般另行居中书写（对于比较简单的文中叙述性公式，可以不另行居中），公式末不加标点符号。公式若有序号，应按章或节顺序编号，并加圆括号写在公式同行右侧行末（即右顶格），公式与序号之间不加连点“”；b）当公式较长时，应在等号处转行；如不能在等号处转行，则可在“+”、“-”等运算符号处转行；c）解释公式中代号或符号用的“式中”、“其中”等词，须另行编排且与该条起首文字对齐，后面加冒号后再写字母代号。代号与解释文字之间用破折号“一一”，上下行的破折号要尽量对齐。若字多，回行时应与上行文字对齐，文末尾加分号，最后一行文末尾加句号OO示例：Pi,J-T2、.(-r)Y/(Y-1)夕？h公式1式中：Pi进气压力，PaxP2排气压力，Pax等病效率；TJ进气温度，k；T2排气温度，k：Y一一比热容量系数。6.2.2.9角标角标的标注要求如下：a）公式中的上、下角、分子、分母都应排列整齐，层次分明。b）应尽可能避免公式中符号的上、下角标本身再带有角标或分式中套分式（繁分式）现象。6.2.2.10数值表述数值的表述应规范化：a）数值的有效位数应全部写出，以反映出所需的精确度；1）小于1的数值写成小数形式时，应在小数点前加上零。22）分数在文字叙述中用斜排（如2/3）,在运算式中用竖排（如可）。3）数值相乘时，应使用乘号（X）,不可使用圆点来表示数值相乘。例如：1.8X10-（不用1.8103）ob）在阿拉伯数字后面应使用计量单位符号、物理量符号，不得使用单位名称或文字说明；c）性能和几何数据的书写，前后应留空，中间加圆点“”；示例：电源直流（27±10%）V输出电流交流115V时为6.96A交流26V时为5.76Ad）表示偏差范围的数值的写法：示例：26°C±2°C或（26±2）°C（不能写做26±2）；28C二或（28：不能写做28：9。（不能写做9。或9）：）；86mm黑*或（86；皿）（不能写做8606m）;e）表示参数范围的数值的写法：示例：53%58%（不能写做53-58%）：2×10-3×103（不能写做23X1（）3）;18C25C（不能写做1825C）；25kg30kg（不能写做2530kg）：25o40°（不能写做2540°）。f）附带尺寸单位的数值相乘的写法：示例：80mmX25mm×50mm或mm:80X25X50（不能写成80X