文件編寫規(guī)范

-.z.-----總結(jié)資料密級：內(nèi)部公開文檔編號：版本號：V1.0分冊名稱：第1冊/共1冊文件編寫標(biāo)準(zhǔn)***科技**生效日期：批準(zhǔn)：文件更改摘要日期版本號修訂說明修訂人審核人批準(zhǔn)人目錄1.目的和范圍42.目標(biāo)43.術(shù)語表44.文檔編號規(guī)則55.文檔命名標(biāo)準(zhǔn)56.文件構(gòu)造規(guī)定67.封面78.修訂頁89.正文內(nèi)容格式810.文件版本號和文件命名規(guī)定910.1.文件版本號規(guī)定910.2.文件命名規(guī)定9目的和范圍背景說明：本文件作為公司內(nèi)部文檔管理文件，所有公司內(nèi)編寫的文檔，均應(yīng)遵守本規(guī)定，作為公司的所有文檔編寫統(tǒng)一要求。范圍：所有的CMMI執(zhí)行過程中產(chǎn)生的文檔，均應(yīng)當(dāng)執(zhí)行本文件要求作為根底的要求，如果該局部的體系文件存在明確的要求的，按照體系文件要求執(zhí)行，沒有的則按照本文件執(zhí)行。目標(biāo)標(biāo)準(zhǔn)和統(tǒng)一公司管理體系中所有相關(guān)文件的風(fēng)格和樣式，指導(dǎo)公司程序文件、模版文件以及各種記錄文件的編寫。術(shù)語表文件標(biāo)識：文件的屬性標(biāo)志，包括文件名稱、文件編號、版本、生效日期、審批狀態(tài)、等。程序文件：描述為完成管理體系中所有主要活動提供方法和指導(dǎo)，分配具體的職責(zé)和任務(wù)而定義的文件。模版文件：為了使管理體系有效運行，組織統(tǒng)一設(shè)計的一些實用的表格和給出活動結(jié)果的報告，標(biāo)準(zhǔn)記錄組織的管理體系運行情況。記錄文件：簡稱記錄，是組織根據(jù)設(shè)計的模版和體系要求，填寫的表格或者給出活動結(jié)果的報告，作為管理體系運行的證據(jù)。修訂頁：記錄文件的修訂歷史，所有程序文件、除了表格以外的模版和記錄都需要有變更履歷，一般位于程序文件的第二頁。文檔：指本文檔的**程度，共分絕密、、秘密、內(nèi)部公開、公開五級制度。絕密：涉及公司與客戶或上游供給商，下游分銷商所簽訂相關(guān)的文檔資料。僅限于公司最高管理層及各資料所涉及的經(jīng)過相應(yīng)管理人員授權(quán)的相關(guān)人員查閱。：公司內(nèi)部所相關(guān)的規(guī)章制度及技術(shù)標(biāo)準(zhǔn)，開發(fā)手冊等；還有各工程開發(fā)文檔、管理文檔及軟件產(chǎn)品等僅供相關(guān)部門高級領(lǐng)導(dǎo)以及經(jīng)過授權(quán)后相關(guān)人員查閱。秘密：需交付用戶或與客戶進(jìn)展交流的文檔與產(chǎn)品，可供相關(guān)工程客戶查閱。內(nèi)部公開：內(nèi)部不限制，公司內(nèi)部任何可以任何形式獲得文檔的信息并閱讀、保存、修改后自用等等，但是不允許向外傳播的文件。公開：工程組開發(fā)過程中的自用文檔或面向售前工作的局部工程介紹材料等。版本標(biāo)識：作為文檔的版本區(qū)分。所有發(fā)布版本之前不得大于1.0，發(fā)布版本作為1.0，而其后只有重大修改可以調(diào)整小數(shù)點前的版本號，局部修改調(diào)整小數(shù)點后版本號，并在修定記錄表中保存記錄。文檔編號規(guī)則過程域與英文標(biāo)識對應(yīng)表：〔SSP：標(biāo)準(zhǔn)過程集〕SSP過程類別SSP定義的過程域英文標(biāo)識過程管理組織過程聚焦OPF組織過程定義OPD組織培訓(xùn)OT工程管理立項PIM集成工程管理IPM工程籌劃PP工程監(jiān)視和控制PMC風(fēng)險管理RSKM結(jié)項PCM采購SAM工程研發(fā)需求開發(fā)與管理RD系統(tǒng)設(shè)計編碼SD產(chǎn)品集成PI測試TS評審TR產(chǎn)品發(fā)布PRDI產(chǎn)品實施PA工程實施與維護(hù)PAM過程支持配置管理CM過程和產(chǎn)品質(zhì)量保證PPQA測量與分析MA決策分析和決定DAR文檔類型與英文標(biāo)識對應(yīng)表：序號文檔類型文檔標(biāo)識1過程Proc2規(guī)程、標(biāo)準(zhǔn)、指南Regu3模版、記錄表格、工具Temp文檔編號編寫規(guī)則：規(guī)則****-過程域標(biāo)識-文檔類型標(biāo)識-文檔英文簡稱說明****為***科技**英文縮寫。文檔簡稱：為英文縮寫。文檔英文簡稱不可重復(fù)。舉例組織過程定義過程,屬于組織過程定義的過程文件，過程域標(biāo)識為OPD，文檔類型標(biāo)識為Proc，簡稱OPDP，則該過程文檔編號為：****–OPD-Proc-OPDP,如有多個在后面加-1、-2區(qū)別文檔命名標(biāo)準(zhǔn)公司所有工程及工程內(nèi)所有技術(shù)文檔應(yīng)按照以下標(biāo)準(zhǔn)進(jìn)展統(tǒng)一命名。一、工程及工程編號的命名標(biāo)準(zhǔn)為〔合同開發(fā)類工程、合同維護(hù)類工程〕：工程命名規(guī)則工程產(chǎn)品舉例城市應(yīng)急救援指揮系統(tǒng)工程編號規(guī)則客戶英文簡稱(或漢語拼音簡稱)-產(chǎn)品英文簡稱舉例RFPreview說明客戶英文簡稱(或漢語拼音簡稱)及產(chǎn)品英文簡稱應(yīng)防止重名二、工程文檔的命名標(biāo)準(zhǔn)為：文檔命名規(guī)則工程命名-過程模板文檔名對可能重名的文檔如工程周報，命名如下：工程編號-過程模板文檔名-〔文檔編者〕注：〔文檔編者〕在不導(dǎo)致文檔名稱重復(fù)的情況下可以省略。舉例RFPreview-立項申請表文檔編號規(guī)則工程編號-過程域-英文編號對可能重復(fù)的文檔編號，命名如下：工程編號-過程域-英文編號，如有多個在后面加-1、-2區(qū)別舉例RFPreview-PIM-IAPR說明工程編號及標(biāo)準(zhǔn)文檔模板編號應(yīng)防止重名文件構(gòu)造規(guī)定所有記錄中除表格之外的文件，在編制過程中應(yīng)按照相關(guān)編制標(biāo)準(zhǔn)編寫。文件通常包括：封面、修訂頁、目錄、頁眉、頁腳和正文。頁碼：頁碼由第1章首頁開場，顯示在頁腳，頁腳左側(cè)為公司全稱,右側(cè)為頁碼.格式第*頁共Y頁(其中*,Y均為阿拉伯)；頁眉：頁眉內(nèi)容為本文檔的文件名稱+版本號；右側(cè)對齊。頁面設(shè)置：除個別特殊需要以外，紙型設(shè)為縱向A4，頁邊距采用默認(rèn)值〔上下均為2.54cm，左右均為3.17cm〕。封面密級：文檔編號：版本號：V1.0分冊名稱：第1冊/共1冊文件名稱***科技**生效日期：修訂頁修訂頁內(nèi)容建議包括：版本號、修改日期、作者〔修改人〕、修訂要點等，如下表所示，可以根據(jù)實際情況添加內(nèi)容。注意，在由模板文件生成實際組織或工程文件后，修訂頁中的原修訂記錄必須去除，改為實際文件的修訂記錄。修訂頁中的版本和作者要與封面的版本和編制一致。日期版本號修訂說明修訂人審核人批準(zhǔn)人正文內(nèi)容格式程序文件正文局部一般建議包含以下內(nèi)容：目的/方針：目的：程序所控制的活動及控制目的；范圍:程序所涉及的有關(guān)部門、活動、相關(guān)人員和產(chǎn)品。術(shù)語表〔可選〕：程序文件中的專用術(shù)語、縮略語等。角色和職責(zé)：規(guī)定負(fù)責(zé)實施該項程序的部門或人員及其責(zé)任和權(quán)限。入口準(zhǔn)則：啟動該程序需要滿足的條件輸入：作為該程序輸入的工作產(chǎn)品流程圖主要活動作活動的邏輯順序?qū)懗鲩_展該項活動的各個環(huán)節(jié)。一般應(yīng)說明以下內(nèi)容：規(guī)定應(yīng)做的事情〔What〕；明確活動的實施者〔Who〕；規(guī)定活動的時間〔When〕；說明在何處實施〔Where〕；規(guī)定具體實施方法〔How〕；所采用的材料、設(shè)備、引用的文件等；如何進(jìn)展控制，應(yīng)保存的記錄；例外特殊情況的處理方式等。輸出：作為該程序輸出的工作產(chǎn)品出口準(zhǔn)則：完畢該程序需要滿足的條件引用文檔：涉及到的相關(guān)程序文件、模版文件以及其他技術(shù)或管理文件。使用模板文件版本號和文件命名規(guī)