09文檔編寫規(guī)范(doc)
目錄 1、 目的 2 2、 范圍 2 3、 文檔首頁(封面) 2 4、 頁眉與頁腳 3 5、 文檔控制和簽字確認 4 6、 目錄 4 7、 正文（含附錄） 4 8、 過程文件中各項內容編排的一般順序 4 目的 為編寫各類技術文檔提供指導，以達到整齊、風格統(tǒng)一的效果，對文檔的格式、命名 、版面、文字等進行了規(guī)范，以供參考。 范圍 適合于Microsoft Word類文檔，但編號規(guī)則適用于全部項目和模版文檔。 文檔首頁(封面) 公司徽記[圖標，居左上角] 文檔名稱[黑體，二號，加粗，居中] 文檔編號[宋體，四號，居中] 版本號[宋體，四號，居中] 作者：[宋體，四號，居中] 年 月 日[宋體，四號，居中] 公司名稱[宋體，四號，居中] o 命名規(guī)則：當前版本沒有設置專門的規(guī)則，只是用中文命名，這個文件名表達了編 寫該文檔的意圖，后綴為相應文檔編輯軟件的擴展名。 o 編號規(guī)則：Q/RKS --- 公司代碼 英文縮寫 1）SP 軟件過程模板類 2）YYXXX 項目工作產品類 YYXXX表示項目代碼，五位：YY：為年號 XXX：為序號 文檔類別，英文縮寫。 例子： GNR 通用類文檔 RM 需求類文檔（包括驗收計劃） SPP 項目計劃類文檔（包括各種測試計劃） SPT 計劃跟蹤和監(jiān)控類文檔 SQA 質量保證類文檔 SCM 配置管理類文檔 PR 評審類文檔 COM 溝通類文檔 DES 設計類文檔 TRN 培訓類文檔 EST 項目估算類文檔 TEC 技術標準類文檔 DEV 開發(fā)規(guī)范類文檔 MTN 維護類文檔 DB 數(shù)據(jù)庫DDL腳本類文檔 QC 測試類文檔 文件按時間產生的順序號，范圍01-99。 例子： Q/RKS-SP-GNR -09 -> 文檔書寫規(guī)范 o 版本編號：初始的版本號為1.0，為適應某一方面的要求進行的升級為點版本升級， 如1.1、1.2等，全面的設計更改或大的變更，升級為2.0、3.0等。 說明：在項目中使用各種模版時，模版中出現(xiàn)的軟件過程模版類編號一律改為項 目工作產品類編號，如軟件需求說明書頁腳的Q/RKS-SP-RM-05改為Q/RKS-YYXXX- RM-SNO。 頁眉與頁腳 (1)、原則：頁面屬性[版式]配置為首頁不同，即首頁之后的頁面均采用本節(jié)規(guī)定的格式 ，[文檔網格]配置為無網格。 (2)、頁眉： 文檔名稱 [宋體，五，左齊] 版本號：[宋體，五，居中] 公司徽記[圖標，右齊] 自動加下劃線 例子： 軟件需求說明書 版本號：1.0 [pic] (3)、頁腳： 文檔ID[宋體，小五，左齊]年 月 日[宋體，小五，居中]Page of [宋體，小五，右齊] 例子： Q/RKS-SP-RM-05 2001年8月15號 Page 1 of 5 說明：在項目使用時，其中版本號為項目文檔的版本號，日期為項目文檔的編寫時間。 文檔控制和簽字確認 有首頁(封面)的放在第二頁，即目錄頁前一頁；無封面放在最后一節(jié)。 例子： 文檔修訂 |版本 |日期 |修改人 |描述（注明修改的條款或頁） | | | | | | | | | | | | | | | | 批準人簽字 |職務 |甲方/乙方 |姓名 |日期 | | | | | | | | | | | 目錄 比較大的文檔可設置目錄頁，配置為顯示頁碼和頁碼右對齊，直接插入即可，單獨成 為一頁。此頁加正文“目錄” [黑體，二號，加粗，居中]。顯示級別為3，格式選模板中“正式”，字體四號。 正文（含附錄） 字體：中文宋體小四，不加粗； 標題1：黑體，三號，加粗(Microsoft word2000缺省)；如:“1.” 標題2：黑體，四號，加粗(Microsoft word2000缺省); 如:“1.1” 標題3：黑體，小四號，加粗(Microsoft word2000缺省), 如:“1.1.1” 編號控制在4級之內。 行間距：單倍行間距。 段落出現(xiàn)兩行以上的首行縮進二個漢字，段落間可加一空行。 過程文件中各項內容編排的一般順序 1. 目的 2. 范圍 3. 職責 4. 工作程序 5. 參考資料
09文檔編寫規(guī)范(doc)