文件編寫(xiě)規(guī)范

1、密密 級(jí)：內(nèi)部公開(kāi)級(jí)：內(nèi)部公開(kāi)文檔編號(hào)：文檔編號(hào)： 版版 本本 號(hào)：號(hào)：V1.0V1.0分冊(cè)名稱(chēng)：第分冊(cè)名稱(chēng)：第 1 1 冊(cè)冊(cè)/ /共共 1 1 冊(cè)冊(cè)文件編寫(xiě)規(guī)范文件編寫(xiě)規(guī)范xxx 科技有限公司科技有限公司編制：生效日期：審核：批 準(zhǔn)：文件編寫(xiě)規(guī)范 V1.0文件更改摘要文件更改摘要日期日期版本號(hào)版本號(hào)修訂說(shuō)明修訂說(shuō)明修訂人修訂人審核人審核人批準(zhǔn)人批準(zhǔn)人文件編寫(xiě)規(guī)范 V1.0目目 錄錄1.1.目的和范圍目的和范圍.42.2.目標(biāo)目標(biāo).43.3.術(shù)語(yǔ)表術(shù)語(yǔ)表.44.文檔編號(hào)規(guī)則文檔編號(hào)規(guī)則.55.文檔命名規(guī)范文檔命名規(guī)范.56.文件結(jié)構(gòu)規(guī)定文件結(jié)構(gòu)規(guī)定.67.封面封面.78.修訂頁(yè)修訂頁(yè).89.正

2、文內(nèi)容格式正文內(nèi)容格式.810.文件版本號(hào)和文件命名規(guī)定文件版本號(hào)和文件命名規(guī)定.910.1.10.1.文件版本號(hào)規(guī)定文件版本號(hào)規(guī)定.910.2.10.2.文件命名規(guī)定文件命名規(guī)定.9文件編寫(xiě)規(guī)范 V1.01.1. 目的和范圍目的和范圍 背景說(shuō)明：背景說(shuō)明：本文件作為公司內(nèi)部文檔管理文件，所有公司內(nèi)編寫(xiě)的文檔，均應(yīng)遵守本規(guī)定，作為公司的所有文檔編寫(xiě)統(tǒng)一要求。 范圍：范圍：所有的 CMMI 執(zhí)行過(guò)程中產(chǎn)生的文檔，均應(yīng)當(dāng)執(zhí)行本文件要求作為基礎(chǔ)的要求，如果該部分的體系文件存在明確的要求的，按照體系文件要求執(zhí)行，沒(méi)有的則按照本文件執(zhí)行。2.2. 目標(biāo)目標(biāo)規(guī)范和統(tǒng)一公司管理體系中所有相關(guān)文件的風(fēng)格和樣式

3、，指導(dǎo)公司程序文件、模版文件以及各種記錄文件的編寫(xiě)。3.3. 術(shù)語(yǔ)表術(shù)語(yǔ)表文文件件標(biāo)標(biāo)識(shí)識(shí)： 文件的屬性標(biāo)志，包括文件名稱(chēng)、文件編號(hào)、版本、生效日期、審批狀態(tài)、密級(jí)等。程序文件：程序文件：描述為完成管理體系中所有主要活動(dòng)提供方法和指導(dǎo)，分配具體的職責(zé)和任務(wù)而定義的文件。模版文件：模版文件：為了使管理體系有效運(yùn)行，組織統(tǒng)一設(shè)計(jì)的一些實(shí)用的表格和給出活動(dòng)結(jié)果的報(bào)告，規(guī)范記錄組織的管理體系運(yùn)行情況。記錄文件：記錄文件：簡(jiǎn)稱(chēng)記錄，是組織根據(jù)設(shè)計(jì)的模版和體系要求，填寫(xiě)的表格或者給出活動(dòng)結(jié)果的報(bào)告，作為管理體系運(yùn)行的證據(jù)。修訂頁(yè)：修訂頁(yè)：記錄文件的修訂歷史，所有程序文件、除了表格以外的模版和記錄都需要有變

4、更履歷，一般位于程序文件的第二頁(yè)。文檔密級(jí)文檔密級(jí)：指本文檔的保密程度，共分絕密、機(jī)密、秘密、內(nèi)部公開(kāi)、公開(kāi)五級(jí)制度。絕密絕密：涉及公司與客戶(hù)或上游供應(yīng)商，下游分銷(xiāo)商所簽訂相關(guān)的文檔資料。僅限于公司最高管理層及各資料所涉及的經(jīng)過(guò)相應(yīng)管理人員授權(quán)的相關(guān)人員查閱。機(jī)密機(jī)密：公司內(nèi)部所相關(guān)的規(guī)章制度及技術(shù)規(guī)范，開(kāi)發(fā)手冊(cè)等；還有各項(xiàng)目開(kāi)發(fā)文檔、管理文檔及軟件產(chǎn)品等僅供相關(guān)部門(mén)高級(jí)領(lǐng)導(dǎo)以及經(jīng)過(guò)授權(quán)后相關(guān)人員查閱。秘密秘密：需交付用戶(hù)或與客戶(hù)進(jìn)行交流的文檔與產(chǎn)品，可供相關(guān)項(xiàng)目客戶(hù)查閱。內(nèi)部公開(kāi)內(nèi)部公開(kāi)： 內(nèi)部不限制，公司內(nèi)部任何可以任何形式獲得文檔的信息并閱讀、保存、修改后自用等等，但是不允許向外傳播的文

5、件。公開(kāi)公開(kāi)：項(xiàng)目組開(kāi)發(fā)過(guò)程中的自用文檔或面向售前工作的部分項(xiàng)目介紹材料等。文件編寫(xiě)規(guī)范 V1.0版本標(biāo)識(shí)版本標(biāo)識(shí)：作為文檔的版本區(qū)分。所有發(fā)布版本之前不得大于 1.0，發(fā)布版本作為1.0，而其后只有重大修改可以調(diào)整小數(shù)點(diǎn)前的版本號(hào)，局部修改調(diào)整小數(shù)點(diǎn)后版本號(hào)，并在修定記錄表中保留記錄。4.4. 文檔編號(hào)規(guī)則文檔編號(hào)規(guī)則過(guò)程域與英文標(biāo)識(shí)對(duì)應(yīng)表：（SSP：標(biāo)準(zhǔn)過(guò)程集）SSP 過(guò)程類(lèi)別過(guò)程類(lèi)別SSP 定義的過(guò)程域定義的過(guò)程域英文標(biāo)識(shí)英文標(biāo)識(shí)組織過(guò)程聚焦OPF組織過(guò)程定義OPD過(guò)程管理組織培訓(xùn)OT立項(xiàng)PIM集成項(xiàng)目管理IPM項(xiàng)目策劃PP項(xiàng)目監(jiān)督和控制PMC風(fēng)險(xiǎn)管理RSKM結(jié)項(xiàng)PCM項(xiàng)目管理采購(gòu)SAM

6、需求開(kāi)發(fā)與管理RD系統(tǒng)設(shè)計(jì)編碼SD產(chǎn)品集成PI測(cè)試TS評(píng)審TR產(chǎn)品發(fā)布PRDI產(chǎn)品實(shí)施PA項(xiàng)目研發(fā)項(xiàng)目實(shí)施與維護(hù)PAM配置管理CM過(guò)程和產(chǎn)品質(zhì)量保證PPQA測(cè)量與分析MA過(guò)程支持決策分析和決定DAR文檔類(lèi)型與英文標(biāo)識(shí)對(duì)應(yīng)表：序號(hào)序號(hào)文檔類(lèi)型文檔類(lèi)型文檔標(biāo)識(shí)文檔標(biāo)識(shí)1過(guò)程Proc2規(guī)程、規(guī)范、指南Regu3模版、記錄表格、工具Temp文檔編號(hào)編寫(xiě)規(guī)則：規(guī)則規(guī)則XXXX-過(guò)程域標(biāo)識(shí)-文檔類(lèi)型標(biāo)識(shí)-文檔英文簡(jiǎn)稱(chēng)說(shuō)明說(shuō)明XXXX 為 xxx 科技有限公司英文縮寫(xiě)。文檔簡(jiǎn)稱(chēng)：為英文縮寫(xiě)。文檔英文簡(jiǎn)稱(chēng)不可重復(fù)。舉例舉例組織過(guò)程定義過(guò)程, 屬于組織過(guò)程定義的過(guò)程文件，過(guò)程域標(biāo)識(shí)為OPD，文檔類(lèi)型標(biāo)識(shí)為 Pr

7、oc，簡(jiǎn)稱(chēng) OPDP，則該過(guò)程文檔編號(hào)為：XXXX OPD-Proc-OPDP,如有多個(gè)在后面加-1、-2 區(qū)別文件編寫(xiě)規(guī)范 V1.05.5. 文檔命名規(guī)文檔命名規(guī)范范公司所有項(xiàng)目及項(xiàng)目?jī)?nèi)所有技術(shù)文檔應(yīng)按照以下規(guī)范進(jìn)行統(tǒng)一命名。一、項(xiàng)目及項(xiàng)目編號(hào)的命名規(guī)范為（合同開(kāi)發(fā)類(lèi)項(xiàng)目、合同維護(hù)類(lèi)項(xiàng)目）：項(xiàng)目命名規(guī)則項(xiàng)目產(chǎn)品舉例城市應(yīng)急救援指揮系統(tǒng)項(xiàng)目編號(hào)規(guī)則客戶(hù)英文簡(jiǎn)稱(chēng)(或漢語(yǔ)拼音簡(jiǎn)稱(chēng))-產(chǎn)品英文簡(jiǎn)稱(chēng)舉例RFPreview說(shuō)明客戶(hù)英文簡(jiǎn)稱(chēng)(或漢語(yǔ)拼音簡(jiǎn)稱(chēng))及產(chǎn)品英文簡(jiǎn)稱(chēng)應(yīng)避免重名二、項(xiàng)目文檔的命名規(guī)范為：項(xiàng)目命名-過(guò)程模板文檔名文檔命名規(guī)則對(duì)可能重名的文檔如項(xiàng)目周報(bào)，命名如下：項(xiàng)目編號(hào)-過(guò)程模板文檔名-

8、（文檔編者）注：（文檔編者）在不導(dǎo)致文檔名稱(chēng)重復(fù)的情況下可以省略。舉例RFPreview-立項(xiàng)申請(qǐng)表項(xiàng)目編號(hào)-過(guò)程域-英文編號(hào)文檔編號(hào)規(guī)則對(duì)可能重復(fù)的文檔編號(hào)，命名如下：項(xiàng)目編號(hào)-過(guò)程域-英文編號(hào)，如有多個(gè)在后面加-1、-2 區(qū)別舉例RFPreview-PIM-IAPR說(shuō)明項(xiàng)目編號(hào)及標(biāo)準(zhǔn)文檔模板編號(hào)應(yīng)避免重名6.6. 文件結(jié)構(gòu)規(guī)定文件結(jié)構(gòu)規(guī)定所有記錄中除表格之外的文件，在編制過(guò)程中應(yīng)按照相關(guān)編制規(guī)范編寫(xiě)。文件通常包括：封面、修訂頁(yè)、目錄、頁(yè)眉、頁(yè)腳和正文。 頁(yè)碼：頁(yè)碼：頁(yè)碼由第 1 章首頁(yè)開(kāi)始，顯示在頁(yè)腳，頁(yè)腳左側(cè)為公司全稱(chēng),右側(cè)為頁(yè)碼.格式第 X 頁(yè) 共 Y 頁(yè)(其中 X,Y 均為阿拉伯)；

9、 頁(yè)眉：頁(yè)眉：頁(yè)眉內(nèi)容為本文檔的文件名稱(chēng)+版本號(hào)；右側(cè)對(duì)齊。 頁(yè)面設(shè)置：頁(yè)面設(shè)置：除個(gè)別特殊需要以外，紙型設(shè)為縱向 A4，頁(yè)邊距采用默認(rèn)值（上下均為 2.54cm，左右均為 3.17cm）。文件編寫(xiě)規(guī)范 V1.07.7. 封面封面密密 級(jí)：級(jí)：文檔編號(hào)：文檔編號(hào)：版版 本本 號(hào)：號(hào)：V1.0V1.0分冊(cè)名稱(chēng)：第分冊(cè)名稱(chēng)：第 1 1 冊(cè)冊(cè)/ /共共 1 1 冊(cè)冊(cè)文件名稱(chēng)文件名稱(chēng)xxx 科技有限公司科技有限公司編制： 生效日期： 審核： 批準(zhǔn)：文件編寫(xiě)規(guī)范 V1.08.8. 修訂頁(yè)修訂頁(yè)修訂頁(yè)內(nèi)容建議包括：版本號(hào)、修改日期、作者（修改人） 、修訂要點(diǎn)等，如下表所示，可以根據(jù)實(shí)際情況添加內(nèi)容。注意，

10、在由模板文件生成實(shí)際組織或項(xiàng)目文件后，修訂頁(yè)中的原修訂記錄必須清除，改為實(shí)際文件的修訂記錄。修訂頁(yè)中的版本和作者要與封面的版本和編制一致。日期日期版本號(hào)版本號(hào)修訂說(shuō)明修訂說(shuō)明修訂修訂人人審核審核人人批準(zhǔn)批準(zhǔn)人人9.9. 正文內(nèi)容格式正文內(nèi)容格式程序文件正文部分一般建議包含以下內(nèi)容：1.1. 目的目的/ /方針：方針： 目的：程序所控制的活動(dòng)及控制目的；2.2. 范圍范圍: :程序所涉及的有關(guān)部門(mén)、活動(dòng)、相關(guān)人員和產(chǎn)品。3.3. 術(shù)語(yǔ)表（可選）：術(shù)語(yǔ)表（可選）：程序文件中的專(zhuān)用術(shù)語(yǔ)、縮略語(yǔ)等。4.4. 角色和職責(zé)：角色和職責(zé)：規(guī)定負(fù)責(zé)實(shí)施該項(xiàng)程序的部門(mén)或人員及其責(zé)任和權(quán)限。5.5. 入口準(zhǔn)則：入

11、口準(zhǔn)則：?jiǎn)?dòng)該程序需要滿(mǎn)足的條件6.6.輸入：輸入：作為該程序輸入的工作產(chǎn)品7.7. 流程圖流程圖8.8. 主要活動(dòng)主要活動(dòng)作活動(dòng)的邏輯順序?qū)懗鲩_(kāi)展該項(xiàng)活動(dòng)的各個(gè)環(huán)節(jié)。一般應(yīng)說(shuō)明以下內(nèi)容：規(guī)定應(yīng)做的事情（What）；明確活動(dòng)的實(shí)施者（Who）；規(guī)定活動(dòng)的時(shí)間（When）；說(shuō)明在何處實(shí)施（Where）；規(guī)定具體實(shí)施辦法（How）；所采用的材料、設(shè)備、引用的文件等；如何進(jìn)行控制，應(yīng)保留的記錄；例外特殊情況的處理方式等。9.9.輸出：輸出：作為該程序輸出的工作產(chǎn)品10.10. 出口準(zhǔn)則：出口準(zhǔn)則：結(jié)束該程序需要滿(mǎn)足的條件11.11. 引用文檔：引用文檔：涉及到的相關(guān)程序文件、模版文件以及其他技術(shù)或管理文件。12.12. 使用模板使用模板文件編寫(xiě)規(guī)范 V1.010.10.文件版本號(hào)和文件命名規(guī)定文件版本號(hào)和文件命名規(guī)定10.1.10.1. 文件版本號(hào)規(guī)定文件版本號(hào)規(guī)定文件的版本號(hào)以“A.B”格式標(biāo)識(shí)，A 和