文件編寫規(guī)范

1、密級(jí)：內(nèi)部公開文檔編號(hào)：版本號(hào)：V1.0分冊(cè)名稱：第1冊(cè)/共1冊(cè)文件編寫規(guī)范xxx科技有限公司編制：生效日期：審核：批準(zhǔn)：文件更改摘要日期版本號(hào)修訂說明修訂人審核人批準(zhǔn)人目錄目的和范圍4目標(biāo)4術(shù)語表4文檔編號(hào)規(guī)則5文檔命名規(guī)范5文件結(jié)構(gòu)規(guī)定6封面7修訂頁8正文內(nèi)容格式8文件版本號(hào)和文件命名規(guī)定9文件版本號(hào)規(guī)定9文件命名規(guī)定9.目的和范圍背景說明：本文件作為公司內(nèi)部文檔管理文件，所有公司內(nèi)編寫的文檔，均應(yīng)遵守本規(guī)定，作為公司的所有文檔編寫統(tǒng)一要求。范圍：所有的CMMI執(zhí)行過程中產(chǎn)生的文檔，均應(yīng)當(dāng)執(zhí)行本文件要求作為基礎(chǔ)的要求，如果該部分的體系文件存在明確的要求的，按照體系文件要求執(zhí)行，沒有的則按照

2、本文件執(zhí)行。.目標(biāo)規(guī)范和統(tǒng)一公司管理體系中所有相關(guān)文件的風(fēng)格和樣式，指導(dǎo)公司程序文件、模版文件以及各種記錄文件的編寫。.術(shù)語表文件標(biāo)識(shí)：文件的屬性標(biāo)志，包括文件名稱、文件編號(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)稱記錄，是組織根據(jù)設(shè)計(jì)的模版和體系要求，填寫的表格或者給出活動(dòng)結(jié)果的報(bào)告，作為管理體系運(yùn)行的證據(jù)。修訂頁：記錄文件的修訂歷史，所有程序文件、除了表格以外的模版和記錄都需要

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

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

5、PAM過程支持配置f理CM過程和產(chǎn)品質(zhì)量保證PPQAr測(cè)量與分析MA決策分析和決定DAR文檔類型與英文標(biāo)識(shí)對(duì)應(yīng)表:序號(hào)文檔類型文檔標(biāo)識(shí)1過程Proc2規(guī)程、規(guī)范、指南Regu3模版、記錄表格、工具Temp文檔編號(hào)編寫規(guī)則:規(guī)則XXXX-過程域標(biāo)識(shí)-文檔類型標(biāo)識(shí)-文檔英文簡(jiǎn)稱說明XXXX為xxx科技后限公司央文縮與。文檔簡(jiǎn)稱：為英義縮寫。文檔英文簡(jiǎn)稱不可重復(fù)。舉例組織過程定義過程，屬于組織過程定義的過程文件，過程域標(biāo)識(shí)為OPD,文檔類型標(biāo)識(shí)為Proc,簡(jiǎn)稱OPDP,則該過程文檔編號(hào)為：XXXXOPD-Proc-OPDP,如有多個(gè)在后面加-1、-2區(qū)別.文檔命名規(guī)范公司所有項(xiàng)目及項(xiàng)目?jī)?nèi)所有技術(shù)文檔

6、應(yīng)按照以下規(guī)范進(jìn)行統(tǒng)一命名。、項(xiàng)目及項(xiàng)目編號(hào)的命名規(guī)范為（合同開發(fā)類項(xiàng)目、合同維護(hù)類項(xiàng)目）項(xiàng)目命名規(guī)則項(xiàng)目產(chǎn)品舉例城市應(yīng)急救援指揮系統(tǒng)項(xiàng)目編號(hào)規(guī)則客戶英文簡(jiǎn)稱（或漢語拼音簡(jiǎn)稱）-產(chǎn)品英文簡(jiǎn)稱舉例RFPreview說明客戶英文簡(jiǎn)稱（或漢語拼音簡(jiǎn)稱）及產(chǎn)品英文簡(jiǎn)稱應(yīng)避免重名、項(xiàng)目文檔的命名規(guī)范為:文檔命名規(guī)則項(xiàng)目命名-過程模板文檔名對(duì)可能重名的文檔如項(xiàng)目周報(bào)，命名如下：項(xiàng)目編號(hào)-過程模板文檔名-（文檔編者）注：（文檔編者）在不導(dǎo)致文檔名稱重復(fù)的情況卜可以省略。舉例RFPreview-立項(xiàng)申請(qǐng)表文檔編號(hào)規(guī)則項(xiàng)目編號(hào)-過程域-英文編號(hào)對(duì)可能重復(fù)的文檔編號(hào)，命名如下：項(xiàng)目編號(hào)-過程域-英文編號(hào)，如有多個(gè)

7、在后面加-1、-2區(qū)別舉例RFPreview-PIM-IAPR說明項(xiàng)目編號(hào)及標(biāo)準(zhǔn)文檔模板編號(hào)應(yīng)避免重名.文件結(jié)構(gòu)規(guī)定所有記錄中除表格之外的文件，在編制過程中應(yīng)按照相關(guān)編制規(guī)范編寫。文件通常包括：封面、修訂頁、目錄、頁眉、頁腳和正文。頁碼：頁碼由第1章首頁開始，顯示在頁腳，頁腳左側(cè)為公司全稱，右側(cè)為頁碼格式第X頁共丫頁（其中X,丫均為阿拉伯）；頁眉：頁眉內(nèi)容為本文檔的文件名稱+版本號(hào)；右側(cè)對(duì)齊。頁面設(shè)置：除個(gè)別特殊需要以外，紙型設(shè)為縱向A4,頁邊距采用默認(rèn)值（上下均為2.54cm,左右均為3.17cm）。7.封面密級(jí)：文檔編號(hào)：版本號(hào)：V1.0分冊(cè)名稱：第1冊(cè)/共1冊(cè)文件名稱xxx科技有限公司編

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

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