文件編寫(xiě)導(dǎo)則
文件編寫(xiě)導(dǎo)則 |文件編號(hào)： |生效日期： |受控編號(hào)： | |NW602101 |2000.3.20 | | |密級(jí)：秘密 |版次：Ver2.1 |修改狀態(tài)： | |總頁(yè)數(shù) |11 |正文 |7 |附錄 |4 | |編制：馬云生 |審核：孟莉 |批準(zhǔn)：孟莉 | 沈陽(yáng)東大阿爾派軟件股份有限公司 (版權(quán)所有,翻版必究) 文件修改控制 |修改記錄編號(hào) |修改 |修改頁(yè)碼及條款 |修改人|審核人|批準(zhǔn)人|修改日期 | | |狀態(tài) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 目錄 1. 目的 1. 適用范圍 2. 術(shù)語(yǔ)和縮略語(yǔ) 1 程序 2 程序文件 3 技術(shù)文檔 4. 編制規(guī)范 4.1 質(zhì)量體系文件的結(jié)構(gòu) 4.2 文件的版面 4.3 文件的封面 4.4 文件的目錄 4.5 文件的正文 4.6 表格文件 4.7 文件編寫(xiě)注意事項(xiàng) 5. 引用文件 附錄一：“質(zhì)量體系文件封面格式” 附錄二：“質(zhì)量體系文件正文格式” 附錄三：“技術(shù)文檔封面格式” 附錄四：“技術(shù)文檔正文格式” 目的 為使公司所用的各種文件的編寫(xiě)規(guī)范、統(tǒng)一、提高工作效率特制定本導(dǎo)則。 適用范圍 適用于質(zhì)量體系文件和技術(shù)性文檔的編寫(xiě)。 術(shù)語(yǔ)和縮略語(yǔ) 3.1 程序（procedure）：本公司質(zhì)量體系文件中所說(shuō)的程序，是指為保證產(chǎn)品質(zhì)量 ，在進(jìn)行軟件開(kāi)發(fā)或質(zhì)量活動(dòng)時(shí)所必須遵守的一系列步驟。不能和軟件開(kāi)發(fā)過(guò) 程產(chǎn)生的計(jì)算機(jī)程序（program）相混淆。 3.2 程序文件：以書(shū)面形式規(guī)定的在軟件開(kāi)發(fā)或質(zhì)量活動(dòng)中所必須遵守的步驟，即 本公司質(zhì)量體系文件結(jié)構(gòu)中的第二層文件。 3.3 技術(shù)文檔：指在軟件開(kāi)發(fā)過(guò)程中所需的各種文檔，它是執(zhí)行質(zhì)量體系文件產(chǎn)生 的結(jié)果。例如，需求分析報(bào)告、詳細(xì)設(shè)計(jì)報(bào)告等。 編制規(guī)范 4.1 質(zhì)量體系文件的結(jié)構(gòu) 本公司質(zhì)量體系文件可分為四層，其結(jié)構(gòu)如下圖： 4.2 文件的版面 所有質(zhì)量體系文件用紙規(guī)格均為A4，頁(yè)面的上、下邊距為20毫米，左邊距為2 5 毫米，右邊距為15毫米；頁(yè)眉邊距為15毫米，頁(yè)腳邊距為17.5毫米。正文行 距為1.5倍行距。 4.3 文件的封面 4.3.1 質(zhì)量體系文件的封面 1) 封面是質(zhì)量體系文件的第一組成部分，文件封面包括公司注冊(cè)圖標(biāo)、文件名 稱(chēng)、公司名稱(chēng)和控制欄； 2) 控制欄包含項(xiàng)目有：受控編號(hào)、保密級(jí)別、文件編號(hào)、修改狀態(tài)、版次、總 頁(yè)數(shù)、正文頁(yè)數(shù)、附錄頁(yè)數(shù)、生效日期、擬制人、審核人、批準(zhǔn)人； 3) 修改狀態(tài)的表示方法：修改狀態(tài)表示為“版次號(hào)+修改標(biāo)識(shí)”，修改標(biāo)識(shí)用一 位大寫(xiě)字母表示，取值從“A~Z”。文件每修改一次，對(duì)應(yīng)一個(gè)修改狀態(tài)， 文件升級(jí)版本時(shí)，修改狀態(tài)清空； 4) 公司圖標(biāo)在頁(yè)眉下邊靠右對(duì)齊； 5) 文件名稱(chēng)居中，距頁(yè)眉約12個(gè)單倍小四行距，字體為楷體小初； 6) 控制欄居中，距文件名稱(chēng)約16個(gè)單倍小四行距，字體為楷體小四號(hào)； 7) 公司名稱(chēng)居中，距控制欄約3個(gè)單倍小四行距，字體為楷體四號(hào)。緊靠在公 司名稱(chēng)的下面是外加括號(hào)的版權(quán)聲明，字體為黑體小三； 8) 程序文件的封面格式具體參見(jiàn)附錄一。 4.3.2 技術(shù)文檔的封面 1) 技術(shù)文檔的封面沒(méi)有頁(yè)眉，其頂部除公司注冊(cè)標(biāo)志外，還包括密級(jí)、文件編 號(hào)、分冊(cè)名稱(chēng)和修改狀態(tài)。字體為幼圓小三，1.5倍行距； 2) 封面的中間部分包括項(xiàng)目名稱(chēng)、文檔名稱(chēng)及開(kāi)發(fā)部門(mén)名稱(chēng)； 3) 封面的底部包括公司名稱(chēng)和頁(yè)腳。頁(yè)腳內(nèi)容和質(zhì)量體系文件相同； 4) 技術(shù)文檔的封面格式具體參見(jiàn)附錄三。 4.4 文件的目錄 目錄是質(zhì)量體系文件的第二部分，在目錄里列出該文件正文部分各項(xiàng)條款的標(biāo) 題，但不超過(guò)兩級(jí)。在目錄頁(yè)內(nèi)“目錄”二字為黑體二號(hào)。 4.5 文件的正文 4.5.1 質(zhì)量手冊(cè)及程序文件的正文要求 質(zhì)量手冊(cè)及程序文件的正文部分包括頁(yè)眉、頁(yè)腳和正文內(nèi)容。 1) 頁(yè)眉由橫線上文件名稱(chēng)、版次、修改狀態(tài)標(biāo)識(shí)和頁(yè)碼組成，頁(yè)眉字體為楷體 小四；頁(yè)腳是在一條橫線下面加上公司名稱(chēng)，字體為楷體五號(hào)。 2) 質(zhì)量體系文件的正文內(nèi)容的字體為宋體小四號(hào)，各條目標(biāo)題的字體為黑體小 四號(hào)。正文后面附的表格內(nèi)字體一般為幼圓五號(hào)。 3) 質(zhì)量體系中程序文件的正文內(nèi)容 程序文件正文部分的內(nèi)容必須包括如下幾項(xiàng) a) 目的 編寫(xiě)本程序文件的主要目的，也可指出本文件控制的活動(dòng)應(yīng)達(dá)到的目的 。 b) 適用范圍 該程序中的活動(dòng)所涉及的工作領(lǐng)域或部門(mén)、崗位、人員，也可簡(jiǎn)單地列 出該程序不適用的領(lǐng)域。 c) 職責(zé) 該程序規(guī)定的活動(dòng)所涉及的責(zé)任部門(mén)或人員的職責(zé)。 d) 術(shù)語(yǔ)和縮略語(yǔ) 術(shù)語(yǔ)──僅在本程序中用到的關(guān)鍵詞和術(shù)語(yǔ)在該條款下列出，并給出其定 義。 縮略語(yǔ)──應(yīng)列出在本程序中用到的所有縮略語(yǔ)，并給出其全稱(chēng)。此外在 縮略語(yǔ)首次出現(xiàn)處也要給出其全稱(chēng)。 e) 工作程序 該項(xiàng)條款向執(zhí)行者提供執(zhí)行工作任務(wù)時(shí)的具體做法。程序中規(guī)定的各步 驟按活動(dòng)的邏輯順序來(lái)編寫(xiě)。在可能或需要時(shí)可用流程圖輔助說(shuō)明。但 流程圖不能取代程序的正文內(nèi)容。 f) 引用文件 列出該程序文件在編寫(xiě)或執(zhí)行中參考的其他程序、管理文件及支持性文 件等。 g) 質(zhì)量記錄 列出執(zhí)行本程序所產(chǎn)生的記錄，這些記錄可以看作是執(zhí)行程序的結(jié)果， 并在附錄給出這些記錄的格式。 以上所規(guī)定的各項(xiàng)條款，對(duì)某個(gè)文件來(lái)說(shuō)，如果有哪一項(xiàng)不適用或該文件對(duì)應(yīng) 這一項(xiàng)沒(méi)有內(nèi)容，必須在文件中加以說(shuō)明（可在該條款下標(biāo)明“無(wú)”或“不適用 ”）。 4.5.2 支持性文件的正文要求 支持性文件正文的頁(yè)眉和頁(yè)腳的要求與程序文件相同。支持性文件的正文標(biāo)題 包括以下幾部分：目的、適用范圍、職責(zé)（可選）、術(shù)語(yǔ)、規(guī)范要求（或作業(yè) 指導(dǎo)等）、引用文件、質(zhì)量記錄和或附錄。其它要求與程序文件相同。 4.5.3 技術(shù)文檔的正文要求 a) 技術(shù)文檔的頁(yè)眉包括文檔名稱(chēng)和頁(yè)碼。頁(yè)腳由一橫線下加上公司名稱(chēng)組成，公 司名稱(chēng)字體為楷體五號(hào)。 b) 技術(shù)文檔的正文內(nèi)容要求參見(jiàn)相應(yīng)的編寫(xiě)規(guī)范，其格式參見(jiàn)附錄四。 4.6 表格文件 文件的附錄一般為各種表格，表格內(nèi)的字體一般為幼圓五號(hào)，表格的格式要求 由相應(yīng)的文件具體規(guī)定。 4.7 文件編寫(xiě)注意事項(xiàng) 4.7.1 程序中使用的語(yǔ)句要簡(jiǎn)單扼要，含義明確，不使用可能引起誤解的語(yǔ)言。盡量 使紙面上的文字描述能夠得到驗(yàn)證，如職責(zé)劃分、對(duì)時(shí)間的要求等。 4.7.2 編寫(xiě)應(yīng)做到“該說(shuō)的要說(shuō)到，說(shuō)到的一定要做到”。不要將不切實(shí)際的作法寫(xiě)入 ，一定要注意文件的可操作性。 4.7.3 對(duì)已有管理制度規(guī)定中實(shí)用的辦法可直接引用，必須寫(xiě)明引用的文件名，編號(hào) 及引用條款。 引用文件 (無(wú)) 附錄一：“質(zhì)量體系文件封面格式” 附錄二：“質(zhì)量體系文件正文格式” 附錄三：“技術(shù)文檔封面格式” 附錄四：“技術(shù)文檔正文格式” 附錄一：質(zhì)量體系文件封面格式 文件名稱(chēng) |文件編號(hào)： |生效日期： |受控編號(hào)： | |密級(jí)：秘密 |版次： |修改狀態(tài)： | |總頁(yè)數(shù) | |正文 | |附錄 | | |編制： |審核： |批準(zhǔn)： | 沈陽(yáng)東大阿爾派軟件股份有限公司 (版權(quán)所有,翻版必究) 附錄二：質(zhì)量體系文件的正文格式 文件名稱(chēng) Ver2.0 P-9/9 正文內(nèi)容 附錄三：技術(shù)文檔封面格式 密級(jí)：機(jī)密 文檔編號(hào)：SE97012SD01 第 版 分冊(cè)名稱(chēng)： 第1冊(cè)/共2冊(cè) 項(xiàng)目名稱(chēng)（項(xiàng)目編號(hào)） 系統(tǒng)設(shè)計(jì)報(bào)告 （部門(mén)名稱(chēng)） 沈陽(yáng)東大阿爾派軟件股份有限公司 |總頁(yè)數(shù) | |正文 | |附錄 | |生效日期： | |編制： |審核： |批準(zhǔn)： | 附錄四：技術(shù)文檔的正文格式 文檔名稱(chēng) 1/5 正文內(nèi)容 ----------------------- [pic] 版次、頁(yè)碼 [pic] 頁(yè)眉為楷體小四號(hào)字 [pic] 黑體二號(hào)字 8行小四號(hào)字、單倍行距 黑體小初號(hào)字 黑體一號(hào)字 空1行小四號(hào)字，單倍行距 楷體小初號(hào)字 空3行小四號(hào)字，單倍行距 黑體三號(hào)字 楷體小三號(hào)字 空10行小四號(hào)字，單倍行距 楷體四號(hào)字 空4行小四號(hào)字，單倍行距 小四號(hào)字，30磅行高 頁(yè)眉為楷體小四號(hào)字 頁(yè)碼 頁(yè)腳為楷體五號(hào)字 頁(yè)腳為楷體五號(hào)字 支持性文件 程序文件 質(zhì)量 手冊(cè)
文件編寫(xiě)導(dǎo)則