文件編寫規(guī)范

1、密密 級：內(nèi)部公開級：內(nèi)部公開文檔編號：文檔編號： 版版 本本 號：號：V1.0V1.0分冊名稱：第分冊名稱：第 1 1 冊冊/ /共共 1 1 冊冊文件編寫規(guī)范文件編寫規(guī)范xxx 科技有限公司科技有限公司編制：生效日期：審核：批 準：文件編寫規(guī)范 V1.0文件更改摘要文件更改摘要日期日期版本號版本號修訂說明修訂說明修訂人修訂人審核人審核人批準人批準人文件編寫規(guī)范 V1.0目目 錄錄1.1.目的和范圍目的和范圍.42.2.目標目標.43.3.術語表術語表.44.文檔編號規(guī)則文檔編號規(guī)則.55.文檔命名規(guī)范文檔命名規(guī)范.56.文件結(jié)構規(guī)定文件結(jié)構規(guī)定.67.封面封面.78.修訂頁修訂頁.89.正

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

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

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

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

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

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

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

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

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

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