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