核電廠交互式電子技術手冊（IETM）第1部分：總則

1核電廠交互式電子技術手冊（IETM）第1部分：總則本文件規(guī)定了核電廠交互式電子技術手冊的功能、內(nèi)容、研制流程等總體要求。本文件適用于核電廠交互式電子技術手冊的研發(fā)、使用和維護等。2規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構成本文件必不可少的條款。其中，注日期的引用文件，僅該日期對應的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB2312信息交換用漢字編碼字符集-基本集ASDS1000D基于公共源數(shù)據(jù)庫的技術出版物國際規(guī)范3術語和定義下列術語和定義適用于本文件。3.1交互式電子技術手冊Interactiveelectronictechnicalmanual(IETM)以數(shù)字形式存儲，采用文字、圖形、表格、音頻和視頻等形式，以交互方式提供核電廠基本原理、操作使用和維修等內(nèi)容的技術出版物。3.2標準編碼系統(tǒng)Standardnumberingsystem(SNS)用于從組成結構或功能結構視角對產(chǎn)品進行劃分的編碼體系。3.3數(shù)據(jù)模塊Datamodule(DM)利用文字、表格、圖形、圖像、動畫、音頻和視頻等多種展現(xiàn)形式，描述核電廠的結構、性能和操作步驟等技術信息的獨立的、完整的數(shù)據(jù)單元。3.4信息控制代碼Informationcontrolnumber(ICN)是由數(shù)字、字母等字符組成的結構化標識符，用以唯一標識及索引與數(shù)據(jù)模塊相關聯(lián)的圖形、圖像、動畫、音頻和視頻等多媒體信息。在CSDB中，信息控制碼用于與一個或多個數(shù)據(jù)模塊建立管理，對插圖或多媒體對象進行控制與訪問。3.5信息碼Informationcode(IC)用于從組成結構或功能結構視角對產(chǎn)品進行劃分的編碼體系。3.6數(shù)據(jù)分發(fā)文件Datadispatchnote(DDN)ASDS1000D標準定義的、以數(shù)據(jù)包方式將IETM數(shù)據(jù)進行分發(fā)的專用文件格式。23.7技術出版物模塊Publicationmodule(PM)用XML語言定義的技術出版物的結構和內(nèi)容。一個PM可由一個或多個數(shù)據(jù)模塊（DM）、PM或外部引用文件組成。3.8模式Schema用于規(guī)范XML文檔的邏輯結構,包括對XML文檔中可用的元素和屬性、子元素的順序和數(shù)量、元素和屬性的數(shù)據(jù)類型等各種元素和屬性使用規(guī)則的定義。3.9機組級multisystemlevel指核電廠內(nèi)，完成特定主體功能的多個相互配合的工藝系統(tǒng)的集合。3.10系統(tǒng)級systemlevel指單個工藝系統(tǒng)所包含的軟硬件設備的集合，如循環(huán)水系統(tǒng)。3.11設備級equipmentlevel具備某項單一功能的單體設備，如循環(huán)水泵。4縮略語下列縮略語適用于本文件。IETM:交互式電子技術手冊(nteractiveelectronictechnicalmanual)IETP:交互式電子技術出版物(InteractiveElectronicTechnicalPublication)CSDB:公共源數(shù)據(jù)庫(CommonSourceDatabase)DM:數(shù)據(jù)模塊(DataModule)DMC:數(shù)據(jù)模塊編碼(DataModuleCode)PM:發(fā)布模塊(PublicationModule)SNS:標準編號系統(tǒng)(StandardNumberingSystem)5概述核電廠交互式電子技術手冊（以下簡稱核電廠IETM）是以ASDS1000D標準為基礎，結合核電廠的設備特性和業(yè)務特點，對S1000D標準進行了裁剪和調(diào)整，同時增加了功能和技術手冊編制的相關標準，用以指導核電廠機組、系統(tǒng)、設備的IETM開發(fā)。6標準體系說明6.1核電廠IETM標準體系如表1所示，其內(nèi)容涉及IETM研制過程的各個環(huán)節(jié)，以確保核電廠機組級、系統(tǒng)級、設備級IETM都能按照統(tǒng)一的方法和要求，完成數(shù)據(jù)的規(guī)劃、編制、管理、發(fā)布和使用等工作。表1數(shù)據(jù)交換文件代碼結構序號規(guī)范名稱規(guī)范內(nèi)容1核電廠交互式電子技術手冊（IETM）第核電廠IETM研制的總體思路、規(guī)31部分：總則范體系及基本流程介紹2核電廠交互式電子技術手冊（IETM）第2部分：數(shù)據(jù)編碼數(shù)據(jù)模塊編碼（DMC）信息控制碼（ICN）等編碼體系的編制要求3核電廠交互式電子技術手冊(IETM)第3部分：數(shù)據(jù)管理數(shù)據(jù)交換、數(shù)據(jù)發(fā)布、數(shù)據(jù)更新等的要求和方法4核電廠交互式電子技術手冊（IETM）第4部分：數(shù)據(jù)模塊編制各類型數(shù)據(jù)模塊的編制要求和方法5核電廠交互式電子技術手冊（IETM）第5部分：功能及界面IETM的功能要求和界面說明6核電廠交互式電子技術手冊（IETM）第6部分：技術手冊內(nèi)容編制開發(fā)IETM所系各類技術資料的的結構和包含內(nèi)容要求6.2核電廠IETM依據(jù)核電廠機組、系統(tǒng)、設備的特性，在S1000D4.0基礎上進行了必要的裁剪和細化，主要體現(xiàn)如下：a)編碼部分細分如下：1)標準編碼系統(tǒng)（SNS）針對核電廠機組、系統(tǒng)、設備的結構和特點進行了進一步的劃分；2)信息碼（IC）的定義和所對應的數(shù)據(jù)模塊類型更加明確；3)數(shù)據(jù)模塊編碼（DMC）、信息控制碼（ICN）各碼段的長度和用法有更嚴格的要求；b)數(shù)據(jù)管理部分細分如下：1)數(shù)據(jù)管理的流程和方法更加明確；2)數(shù)據(jù)交換的方式和要求更加明確；c)數(shù)據(jù)編制部分細分如下：1)對數(shù)據(jù)模塊（DM）的類型及Schema中的元素和屬性進行了裁剪；2)對插圖、多媒體等內(nèi)容的編制有更加明確的要求；d)功能及界面要求細分如下：1)對IETM的功能有更詳細和明確的要求；2)對IETM的界面的設計具有更明確地指導意義；e)技術手冊內(nèi)容部分細分如下：1)對技術資料的種類提出了明確的要求；2)對每一類型技術資料的結構和包含內(nèi)容有了更詳細和具體的指導說明。6.3核電廠IETM標準是適用于所有核電廠機組級、系統(tǒng)級、設備級IETM開發(fā)的通用標準，在具體IETM的研制過程中，需對此標準中未明確的內(nèi)容進行明確定義，如型號識別碼（MI）的具體取值、系統(tǒng)差異碼（SDC）的取值等；也可以對此標準中已給出明確要求的內(nèi)容提出更嚴格的要求，如數(shù)據(jù)模塊Schema的進一步裁剪、插圖和多媒體的進一步編制要求等，但必須在本規(guī)范體系的要求范圍之內(nèi)。7IETM一般要求參照ASDS1000D和GJB6600-2009標準要求，IETM應符合下列基本要求：a)信息展示方式應便于瀏覽和理解，操作方式應便捷、高效；b)信息之間應具備關聯(lián)關系，便于信息關聯(lián)展示；4c)應具備對話框、選擇框等多種交互方式，便于人機交互和信息的獲取；d)應具備手冊目錄、產(chǎn)品結構等多種導航方式，便于用戶定位瀏覽；e)應具備便捷的數(shù)據(jù)導入導出能力，便于信息內(nèi)容的維護和更新；f)IETM應具備安全管控措施，保證數(shù)據(jù)安全；g)應具備在網(wǎng)絡環(huán)境中安裝、運行能力。8內(nèi)容要求IETM內(nèi)容應符合下列要求：a)語句表述應簡明扼要，無歧義，單個語句不宜過長；b)每個段落應只有一個明確的重心主題；c)結論性的并列語句需按照邏輯順序以序列方式表述；d)漢字編碼符合GB2312的規(guī)定。9核電廠IETM研制流程要求9.1總體研制流程核電廠IETM的研制由各相關單位共同完成，整個IETM的研制過程可分為四個大的階段，各階段的具體工作及所需參考的標準如所示。圖1核電廠IETM研制流程9.2IETM規(guī)劃9.2.1總體單位按照核電廠IETM第1部分總則的說明，明確通用規(guī)范中所規(guī)定的內(nèi)容，并根據(jù)具體IETM的實際情況對相關事項提出更加明確和嚴格的要求，結合機組、系統(tǒng)、設備等的運行維修等方面的要求，確定其技術資料范圍，依照技術資料要求整理資料結構和內(nèi)容，并形成具體指導IETM開發(fā)的頂層要求，明確各類手冊的技術內(nèi)容要求和編碼要求等，為后期數(shù)據(jù)內(nèi)容的編寫提供依據(jù)。9.2.2配套單位需明確總體單位下發(fā)的IETM頂層要求，并貫徹到所研制產(chǎn)品的IETM數(shù)據(jù)規(guī)劃中。59.3IETM數(shù)據(jù)編制和管理9.3.1總體單位和各配套單位按照核電廠IETM標準和具體IETM編制頂層要求進行IETM數(shù)據(jù)的編制，主要包括：a)編制DM：總體單位和各配套單位按照第4部分數(shù)據(jù)模塊編制的要求完成所有DM的編制；b)制作插圖和多媒體：總體單位和各配套單位根據(jù)其DM內(nèi)容的需要，制作所需的插圖和多媒體，具體要求參照第4部分數(shù)據(jù)模塊編制；c)編制PM：根據(jù)IETM編制頂層要求中對手冊結構的要求，編制對應的PM，具體要求參見第3部分數(shù)據(jù)管理。原則上，所有IETM的PM均由總體單位編制，配套單位不參與PM的編制工作，除非總體單位在IETM編制頂層要求中有更明確的要求?？傮w單位編制PM的時機可根據(jù)IETM研制的具體情況定，可以在頂層要求完成后依據(jù)其結構進行PM的編制，也可以在各單位的數(shù)據(jù)完成集成后再開展PM的編制。9.3.2為了在數(shù)據(jù)編制過程中對所有IETM數(shù)據(jù)進行有效的管理，各單位應按照第3部分數(shù)據(jù)管理，建立公共源數(shù)據(jù)庫，對IETM數(shù)據(jù)進行統(tǒng)一管理，確保數(shù)據(jù)的唯一性和準確性。9.4IETM數(shù)據(jù)集成9.4.1各配套單位按頂層要求完成數(shù)據(jù)編制以及內(nèi)部驗證后，以數(shù)據(jù)分發(fā)說明（DDN）的形式導出所研制產(chǎn)品的IETM數(shù)據(jù)包，并按照總體單位要求的方式提交數(shù)據(jù)。9.4.2總體單位根據(jù)相關規(guī)范的要求對各配套單位提交的數(shù)據(jù)進行質(zhì)量檢驗，并督促各配套單位按質(zhì)量檢驗過程中反饋的問題修改數(shù)據(jù)，直至滿足型號要求。9.4.2.1數(shù)據(jù)交換的詳細要求參照第3部分數(shù)據(jù)管理?？傮w