文檔編寫規(guī)范
為編寫各類技術(shù)文檔提供指導(dǎo)，以達(dá)到整齊、風(fēng)格統(tǒng)一的效果，對(duì)文檔的格式、命名、版面、文字等進(jìn)行了規(guī)范，以供參考。
2、 范圍
適合于Microsoft Word類文檔，但編號(hào)規(guī)則適用于全部項(xiàng)目和模版文檔。
3、 文檔首頁(yè)(封面)
<頁(yè)首>公司徽記[圖標(biāo)，居左上角]

文檔名稱[黑體，二號(hào)，加粗，居中]
文檔編號(hào)[宋體，四號(hào)，居中]
版本號(hào)[宋體，四號(hào)，居中]

<頁(yè)尾> 作者：[宋體，四號(hào)，居中]
年 月 日[宋體，四號(hào)，居中]
公司名稱[宋體，四號(hào)，居中]


 命名規(guī)則：當(dāng)前版本沒(méi)有設(shè)置專門的規(guī)則，只是用中文命名，這個(gè)文件名表達(dá)了編寫該文檔的意圖，后綴為相應(yīng)文檔編輯軟件的擴(kuò)展名。
 編號(hào)規(guī)則：Q/RKS -<ID>-<TYPE>-<SNO>
<Q/RKS> 公司代碼
< ID > 英文縮寫
1）SP 軟件過(guò)程模板類
2）YYXXX 項(xiàng)目工作產(chǎn)品類
YYXXX表示項(xiàng)目代碼，五位：YY：為年號(hào) XXX：為序號(hào)

<TYPE> 文檔類別，英文縮寫。
例子： GNR 通用類文檔
RM 需求類文檔（包括驗(yàn)收計(jì)劃）
SPP 項(xiàng)目計(jì)劃類文檔（包括各種測(cè)試計(jì)劃）
SPT 計(jì)劃跟蹤和監(jiān)控類文檔
SQA 質(zhì)量保證類文檔
SCM 配置管理類文檔
PR 評(píng)審類文檔
COM 溝通類文檔
DES 設(shè)計(jì)類文檔
TRN 培訓(xùn)類文檔
EST 項(xiàng)目估算類文檔
TEC 技術(shù)標(biāo)準(zhǔn)類文檔
DEV 開(kāi)發(fā)規(guī)范類文檔
MTN 維護(hù)類文檔
DB 數(shù)據(jù)庫(kù)DDL腳本類文檔
QC 測(cè)試類文檔

<SNO> 文件按時(shí)間產(chǎn)生的順序號(hào)，范圍01-99。
例子： Q/RKS-SP-GNR -09 -> 文檔書(shū)寫規(guī)范

 版本編號(hào)：初始的版本號(hào)為1.0，為適應(yīng)某一方面的要求進(jìn)行的升級(jí)為點(diǎn)版本升級(jí)，如1.1、1.2等，全面的設(shè)計(jì)更改或大的變更，升級(jí)為2.0、3.0等。

說(shuō)明：在項(xiàng)目中使用各種模版時(shí)，模版中出現(xiàn)的軟件過(guò)程模版類編號(hào)一律改為項(xiàng)目工作產(chǎn)品類編號(hào)，如軟件需求說(shuō)明書(shū)頁(yè)腳的Q/RKS-SP-RM-05改為Q/RKS-YYXXX-RM-SNO。
4、 頁(yè)眉與頁(yè)腳
(1)、原則：頁(yè)面屬性[版式]配置為首頁(yè)不同，即首頁(yè)之后的頁(yè)面均采用本節(jié)規(guī)定的格式，[文檔網(wǎng)格]配置為無(wú)網(wǎng)格。
(2)、頁(yè)眉： 文檔名稱 [宋體，五，左齊] 版本號(hào)：[宋體，五，居中] 公司徽記[圖標(biāo)，右齊]
自動(dòng)加下劃線
例子：
軟件需求說(shuō)明書(shū) 版本號(hào)：1.0

(3)、頁(yè)腳：

文檔ID[宋體，小五，左齊]年 月 日[宋體，小五，居中]Page of [宋體，小五，右齊]

例子：

Q/RKS-SP-RM-05 2001年8月15號(hào) Page 1 of 5

說(shuō)明：在項(xiàng)目使用時(shí)，其中版本號(hào)為項(xiàng)目文檔的版本號(hào)，日期為項(xiàng)目文檔的編寫時(shí)間。
5、 文檔控制和簽字確認(rèn)
有首頁(yè)(封面)的放在第二頁(yè)，即目錄頁(yè)前一頁(yè)；無(wú)封面放在最后一節(jié)。

例子：
文檔修訂
版本 日期 修改人 描述（注明修改的條款或頁(yè)）




批準(zhǔn)人簽字
職務(wù) 甲方/乙方 姓名 日期



6、 目錄
比較大的文檔可設(shè)置目錄頁(yè)，配置為顯示頁(yè)碼和頁(yè)碼右對(duì)齊，直接插入即可，單獨(dú)成為一頁(yè)。此頁(yè)加正文“目錄” [黑體，二號(hào)，加粗，居中]。顯示級(jí)別為3，格式選模板中“正式”，字體四號(hào)。
7、 正文（含附錄）
字體：中文宋體小四，不加粗；
標(biāo)題1：黑體，三號(hào)，加粗(Microsoft word2000缺省)；如:“1.”
標(biāo)題2：黑體，四號(hào)，加粗(Microsoft word2000缺省); 如:“1.1”
標(biāo)題3：黑體，小四號(hào)，加粗(Microsoft word2000缺省), 如:“1.1.1”
編號(hào)控制在4級(jí)之內(nèi)。
行間距：?jiǎn)伪缎虚g距。
段落出現(xiàn)兩行以上的首行縮進(jìn)二個(gè)漢字，段落間可加一空行。
8、 過(guò)程文件中各項(xiàng)內(nèi)容編排的一般順序

文檔編寫規(guī)范