CMMI-文件編寫規(guī)范

文件編寫規(guī)范文件編號(hào)保密級(jí)別總頁(yè)數(shù)編制

變更日志編號(hào)版本修改內(nèi)容修改人修改日期10.10創(chuàng)建初稿20.20內(nèi)部評(píng)審31.00發(fā)布目錄1 編寫目的 32 適用范圍 23 文件編制規(guī)范 33.1 文件的結(jié)構(gòu) 33.2 文件的版面 43.3 封面 43.3.1 技術(shù)說明書、用戶手冊(cè)、配置手冊(cè)、標(biāo)書封面 43.3.2 設(shè)計(jì)文檔、考察研究報(bào)告、輸入文件封面 43.4 變更日志 53.5 扉頁(yè) 53.6 目錄 63.7 正文 63.7.1 頁(yè)眉和頁(yè)腳 63.7.2 各級(jí)標(biāo)題 63.7.3 正文內(nèi)容 73.7.4 表格文件 73.7.5 圖文件 83.8 封三 83.9 封底 84 打印 8A.1技術(shù)文件封面示例 9A.2變更日志示例 10A.3扉頁(yè)示例 11A.4目錄 12A.5封底示例 13文件編寫規(guī)范PAGE13編寫目的為使公司所用的各種文件編寫規(guī)范、統(tǒng)一，進(jìn)而提高工作效率特編寫本文。適用范圍本文適用于以下文檔，超出本范圍的文檔，也可借鑒本文提供的格式和要求。組織體系文件設(shè)計(jì)文檔技術(shù)說明書用戶手冊(cè)配置手冊(cè)考察研究報(bào)告輸入文件標(biāo)書文件編制規(guī)范文件的結(jié)構(gòu)其中《技術(shù)說明書》、《用戶手冊(cè)》、《配置手冊(cè)》、《標(biāo)書》四類文件結(jié)構(gòu)為：封面、扉頁(yè)、目錄、正文、封三、封底；《設(shè)計(jì)文檔》、《考察研究報(bào)告》、《輸入文件》三類文件結(jié)構(gòu)為封面、變更日志、目錄、正文。建立文件時(shí)，需對(duì)文件的屬性進(jìn)行填寫。文件的版面NTS8300、NTS8700、NTS-500、NTS-700、NTS-800、NTS-900產(chǎn)品《用戶手冊(cè)》、《配置手冊(cè)》用紙規(guī)格均為A5，頁(yè)邊距設(shè)置分別為上1.5cm，下1.5cm，左2.0cm，右1.0cm；頁(yè)眉到邊緣距離：0.55cm；頁(yè)腳到邊緣距離：0.85cm；正文行距為：1.5倍行距。所有《技術(shù)說明書》、《設(shè)計(jì)文檔》、《考察研究報(bào)告》、《輸入文件》、《標(biāo)書》用紙規(guī)格為A4，頁(yè)邊距設(shè)置分別為上2.0cm，下2.0cm，左2.5cm，右1.5cm；頁(yè)眉到邊緣距離：1.5cm，頁(yè)腳到邊緣距離：1.75cm；正文行距為：1.5倍行距。其他不在此范圍內(nèi)的資料可參考上述標(biāo)準(zhǔn)執(zhí)行。封面技術(shù)說明書、用戶手冊(cè)、配置手冊(cè)、標(biāo)書封面封面為該類文件第一組成部分，封面包括文件名稱、封面圖片、公司名稱三大組成部分。該封面風(fēng)格按當(dāng)前應(yīng)用的規(guī)范應(yīng)用，暫不作強(qiáng)制規(guī)定，但同類文件需保持統(tǒng)一樣式。設(shè)計(jì)文檔、考察研究報(bào)告、輸入文件封面該類文件封面包括公司LOGO、文件名稱、控制欄、公司名稱及版權(quán)聲明五個(gè)組成部分；公司LOGO設(shè)置：采用圖片型式，如下圖3-1所示，圖片高度1.15cm，縱橫比例鎖定，四周型版式，居中，距頁(yè)眉4個(gè)單倍小四行距；圖3-1公司LOGO文件名稱設(shè)置：距LOGO10個(gè)單倍小四行距，采用初號(hào)黑體加粗居中，名稱較長(zhǎng)時(shí)可分行顯示，1行不超過10個(gè)漢字；控制欄設(shè)置：距文件名稱12個(gè)單倍小四行距，字體為黑體小四號(hào)?？刂茩跒楸砀裥褪?，表格行高統(tǒng)一為1cm，文字為黑體小四，文字居中。表格按窗口自動(dòng)調(diào)整。其中修改狀態(tài)的表示方法：修改狀態(tài)表示為“版次號(hào)+修改標(biāo)識(shí)”，修改標(biāo)識(shí)用一位大寫字母表示，取值從“A～Z”。文件每修改一次，對(duì)應(yīng)一個(gè)修改狀態(tài)，文件升級(jí)版本時(shí)，修改狀態(tài)清空?？刂茩诰唧w內(nèi)容如表3-1所示：文件編號(hào)XX-X-XXXXX-XX生效日期090312受控編號(hào)保密級(jí)別二級(jí)版本號(hào)V1.15修改狀態(tài)F總頁(yè)數(shù)7正文4附錄無(wú)編制審核批準(zhǔn)表3-1控制欄公司名稱設(shè)置：采用圖片型式，距控制欄約3個(gè)單倍小四行距，圖片設(shè)置為嵌入型版式，居中，高0.61厘米，縱橫比例鎖定，如下圖3-2所示；圖3-2公司名稱版權(quán)聲明設(shè)置：位于公司名稱下方，緊接公司名稱，字體為黑體小三加粗，居中，外加括號(hào)；格式具體參見A.1技術(shù)文件封面示例。變更日志非一次性文件都要有有變更日志，如《設(shè)計(jì)文檔》、《輸入文件》等，具體格式參見A.2變更日志示例。其中“變更日志”字體為黑體三號(hào)加粗，段落為1.5倍行距，表格中的文字為宋體小四居中，表格設(shè)為按窗口自動(dòng)調(diào)整。扉頁(yè)《設(shè)計(jì)文檔》、《考察研究報(bào)告》、《輸入文件》、《標(biāo)書》四類文件需有扉頁(yè)，扉頁(yè)是該類文件的第二組成部分，扉頁(yè)包括公司LOGO、產(chǎn)品名稱、文件名稱、文件版本號(hào)、公司名稱、編寫日期六類組成部分；公司LOGO設(shè)置：采用圖片型式，如圖3-1所示，圖片高度1.15cm，縱橫比例鎖定，嵌入型版式，居中，距頁(yè)眉約4個(gè)單倍小四行距；產(chǎn)品名稱設(shè)置：距LOGO約2個(gè)單倍小四行距。其中，《技術(shù)說明書》、《用戶手冊(cè)》、《配置手冊(cè)》三類文件產(chǎn)品名稱字體設(shè)為小一號(hào)黑體加粗居中，名稱較長(zhǎng)時(shí)可分行顯示，1行不超過10個(gè)漢字；《標(biāo)書》文件產(chǎn)品名稱位置填寫標(biāo)書名稱，字體設(shè)置為初號(hào)黑體加粗居中，名稱較長(zhǎng)時(shí)可分行顯示，1行不超過10個(gè)漢字；文件名稱設(shè)置：距產(chǎn)品名稱4個(gè)單倍小四行距，縱向表示。其中，《技術(shù)說明書》、《用戶手冊(cè)》、《配置手冊(cè)》三類文件產(chǎn)品名稱字體設(shè)為小一號(hào)黑體加粗居中；《標(biāo)書》文件此處顯示為“投標(biāo)文件”，字體設(shè)置為初號(hào)黑體加粗居中；文件版本號(hào)設(shè)置：距文件名稱8個(gè)單倍小四行距，字體采用三號(hào)黑體居中；公司名稱設(shè)置：采用圖片型式位于日期正下方，圖片設(shè)置為嵌入型版式，居中，高0.61厘米，縱橫比例鎖定，如圖3-2所示；編寫日期設(shè)置：位于公司名稱下方，字體設(shè)置為三號(hào)黑體居中；《標(biāo)書》文件扉頁(yè)格式詳見A.3扉頁(yè)示例。目錄目錄撰寫格式設(shè)置：“目錄”兩字（三號(hào)黑體），居中，下空2個(gè)單倍小四行距，目錄顯示三級(jí)大綱。文字為小四宋體，段落設(shè)置為段前0行，段后0.5行，單倍行距。章、節(jié)、小節(jié)分別以“1”、“1.1”、“1.1.1”等數(shù)字依次標(biāo)出。目錄設(shè)置格式為如下圖：圖3-3目錄設(shè)置目錄一般為文件編寫結(jié)束后自動(dòng)生成。目錄部分不用頁(yè)眉、頁(yè)腳。格式參見A.4目錄。正文正文部分包括頁(yè)眉、頁(yè)腳、各級(jí)標(biāo)題、正文內(nèi)容、表格和圖。注意事項(xiàng)：同一級(jí)別和使用同樣項(xiàng)目符號(hào)的文字要在同一縱軸線上；對(duì)于雙面打印的文件，一章的開始一定要在奇數(shù)頁(yè)上；當(dāng)標(biāo)題和相應(yīng)內(nèi)容不在同一頁(yè)面時(shí)，調(diào)整標(biāo)題到下一頁(yè)面；調(diào)整圖的位置大小，保證其在打印區(qū)內(nèi)。頁(yè)眉和頁(yè)腳前言或引言需單獨(dú)編注頁(yè)碼，不加頁(yè)眉和頁(yè)腳。頁(yè)眉的左邊為公司LOGO圖片，圖片高度為0.4cm，鎖定縱橫比，左對(duì)齊；頁(yè)眉的右邊為文件的名稱，字體設(shè)為宋體五號(hào)加粗；頁(yè)眉段前0行，段后0.5行，頁(yè)眉下方有0.5磅橫線。頁(yè)腳為頁(yè)碼居中即可。各級(jí)標(biāo)題標(biāo)題第一級(jí)為“1”、“2”、“3”等，第二級(jí)為“1.1”、“1.2”、“1.3”等，第三級(jí)為“1.1.1”、“1.1.2”、“1.1.3”等，各級(jí)末尾不加標(biāo)點(diǎn)。注意事項(xiàng)：每章標(biāo)題字體設(shè)置為三號(hào)黑體加粗居中，設(shè)定大綱級(jí)別為1級(jí)，段前、段后均為6磅，1.5倍行距；各節(jié)（如“1.1”）字體設(shè)置為四號(hào)黑體加粗左起頂格，設(shè)定大綱級(jí)別為2級(jí)，段前4磅，段后3磅，1.5倍行距；各小節(jié)（如“1.1.1”）字體設(shè)置為小四號(hào)黑體加粗左起頂格打印，設(shè)定大綱級(jí)別為3級(jí)，段前、段后為0磅，1.5倍行距；換行后打印正文。正文中總項(xiàng)包括的分項(xiàng)采用（1）、（2）、（3）…的序號(hào)，縮進(jìn)2.1cm；對(duì)分項(xiàng)中的小項(xiàng)采用①、②、③…的序號(hào)，縮進(jìn)4cm；項(xiàng)目編號(hào)可以采用項(xiàng)目符號(hào)加以標(biāo)注。可根據(jù)實(shí)際情況自選，一份文件建議只使用一種，統(tǒng)一規(guī)范。正文內(nèi)容正文字體設(shè)置為五號(hào)宋體，首行縮進(jìn)2個(gè)字符，段前0磅，段后0磅，1.5倍行距。表格文件文檔中會(huì)插入各種表格，表格內(nèi)的字體設(shè)置為宋體五號(hào)，表格的格式要求由相應(yīng)的文件具體規(guī)定。表格按章順序編號(hào)，如表5-4為第五章第張四表，編號(hào)后空一格顯示表格名稱，編號(hào)和名稱的位置為該表格的正下方居中，字體為宋體5號(hào)。如下表3-2所示：圖符說明方向鍵“上”，用于切換菜單及輸入密碼（文中用↑表示）方向鍵“下”，用于切換菜單及輸入密碼（文中用↓表示）方向鍵“左”，用于切換菜單及輸入密碼（文中用←表示）方向鍵“右”，用于切換菜單及輸入密碼（文中用→表示）修改鍵“加”，用于切換參數(shù)選項(xiàng)，或增大數(shù)字修改鍵“減”，用于切換參數(shù)選項(xiàng)，或減小數(shù)字用于確認(rèn)用戶所做的操作，或進(jìn)入下級(jí)菜單，或自運(yùn)行顯示狀態(tài)調(diào)出主菜單用于中止用戶所做的操作，或退到上一級(jí)菜單，或從主菜單切換到運(yùn)行顯示狀態(tài)復(fù)歸處于保持狀態(tài)的異常信號(hào)燈，或信號(hào)繼電器，當(dāng)異常信號(hào)還未消失時(shí)，無(wú)效表3-2鍵盤說明表圖文件為了方便說明和用戶使用，會(huì)插入各種圖文件，圖的大小由圖內(nèi)文字大小決定，相同規(guī)格的圖大小應(yīng)一致，大圖版式一般建議使用嵌入式，小圖建議采用四周型，根據(jù)實(shí)際情況自選，保證圖、字顯示清楚，整潔。圖號(hào)按章順序編號(hào)，如圖3-2為第三章第二圖。編號(hào)后空一格顯示圖名稱，編號(hào)和名稱的位置為該圖的正下方居中，字體為宋體5號(hào)，段落為段前0.5行，段后0.5行，單倍行距。如圖3-4所示。圖3-4理念封三封三頁(yè)采用圖3-4圖標(biāo)，圖片高度設(shè)定為4cm，版式四周型，居中，位于頁(yè)面三分之一處。封底封底是文件的最后部分，文件封底包括公司中英文全稱、公司地址、郵編、總機(jī)、業(yè)務(wù)聯(lián)系、技術(shù)支持、傳真、公司網(wǎng)址等信息。其中《技術(shù)說明書》、《用戶手冊(cè)》、《配置手冊(cè)》三類文件采用統(tǒng)一的封底，具體參見A.5封底示例。打印《技術(shù)說明書》、《用戶手冊(cè)》、《配置手冊(cè)》三類文件打印時(shí)選取A4紙張，頁(yè)面設(shè)置為書籍折頁(yè)，手動(dòng)雙面打印。注意：正面打印完成后需將紙張倒序，將紙張按要求放入打印機(jī)紙盒內(nèi)，繼續(xù)打印反面?！对O(shè)計(jì)文檔》、《考察研究報(bào)告》、《輸入文件》、《標(biāo)書》四類文件打印無(wú)需特殊設(shè)置，如需雙面打印，則選擇手動(dòng)雙面打印。A.1技術(shù)文件封面示例文件編寫規(guī)范文件編號(hào)生效日期071205受控編號(hào)保密級(jí)別版本號(hào)V0.1修改狀態(tài)總頁(yè)數(shù)正文附錄編制審核批準(zhǔn)(版權(quán)所有,翻版必究)A.2變更日志示例變更日志編號(hào)版本修改內(nèi)容修改人修改日期1V1.01項(xiàng)目編號(hào)修改，目錄修改。張瑋0901212V1.02內(nèi)容校核、調(diào)整。趙航宇090311A.3扉頁(yè)示例XXXX股份有限公司投標(biāo)文件版本：V1.022007年11月A.4目錄目錄1 編寫目的 32 適用范圍 23 文件編制規(guī)范 33.1 文件的結(jié)構(gòu) 33.2 文件的版面 43.3 封面 43.3.1 技術(shù)說明書、用戶手冊(cè)、配置手冊(cè)、標(biāo)書封面 43.3.2 設(shè)計(jì)文檔、考察研究報(bào)告、輸入文件封面 43.4 變更日志 53.5 扉頁(yè) 53.6 目錄 63.7 正文 63.7.1 頁(yè)眉和頁(yè)腳 63.7.2 各級(jí)標(biāo)題 63.7.3 正文內(nèi)容 73.7.4 表格文件 73.7.5 圖文件