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

文件編寫(xiě)規(guī)范XXXXXX有限公司文件編號(hào)GF_OPF_REGU_FNS當(dāng)前版本V1.0機(jī)密等級(jí)20XX編制者審核者批準(zhǔn)者批準(zhǔn)日期20XX-5-15XXXXXX有限公司對(duì)本文件資料享受著作權(quán)及其它專屬權(quán)利，未經(jīng)書(shū)面許可,不得將該等文件資料（其全部或任何部分）披露予任何第三方，或進(jìn)行修改后使用。XXXXXXXX公司#文件更改摘要：日期版本號(hào)修訂說(shuō)明修訂人審核人批準(zhǔn)人20XX-5-15V1.0正式發(fā)布目錄TOC\o"1-5"\h\z丄目的和范圍32.目標(biāo)3玄術(shù)語(yǔ)表3文檔編號(hào)規(guī)則4文檔命名規(guī)范5項(xiàng)目命名552.項(xiàng)目文檔命名5文件結(jié)構(gòu)規(guī)定6Word文件6Excel文件7封面8&文件更改摘要8版本標(biāo)識(shí)9管理文件版本標(biāo)識(shí)：9酉己置項(xiàng)版本標(biāo)識(shí)：9基線版本標(biāo)識(shí)：10模板應(yīng)用要求10OSP文檔編號(hào)11引用文檔111.目的和范圍?背景說(shuō)明：本文件作為XXXXXX有限公司內(nèi)部文檔管理文件，所有公司內(nèi)編寫(xiě)的文檔，均應(yīng)遵守本規(guī)定，作為公司的所有文檔編寫(xiě)統(tǒng)一要求。?范圍：所有的CMMI執(zhí)行過(guò)程中產(chǎn)生的文檔，均應(yīng)當(dāng)執(zhí)行本文件要求，如果該部分的體系文件存在明確的要求的，按照體系文件要求執(zhí)行，沒(méi)有的則按照本文件執(zhí)行。目標(biāo)規(guī)范和統(tǒng)一公司管理體系中所有相關(guān)文件的風(fēng)格和樣式，指導(dǎo)公司程序文件、模板文件以及各種記錄文件的編寫(xiě)。術(shù)語(yǔ)表?文件標(biāo)識(shí)：文件的屬性標(biāo)志，包括文件名稱、文件編號(hào)、版本、生效日期、審批狀態(tài)、密級(jí)等。過(guò)程、規(guī)程文件：描述為完成管理體系中所有主要活動(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ì)的模板和體系要求，填寫(xiě)的表格或者給出活動(dòng)結(jié)果的報(bào)告，作為管理體系運(yùn)行的證據(jù)。?文檔密級(jí)：指本文檔的保密程度，共分絕密、機(jī)密、秘密、20XX、公開(kāi)五級(jí)制度。絕密：涉及公司與客戶或供應(yīng)商所簽訂相關(guān)的文檔資料。僅限于公司最高管理層及相應(yīng)管理人員查閱。機(jī)密：公司內(nèi)部的規(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)人員查閱。秘密：需交付用戶或與客戶進(jìn)行交流的文檔與產(chǎn)品，可供相關(guān)項(xiàng)目客戶查閱。20XX：內(nèi)部不限制，公司內(nèi)部任何人可以任何形式獲得文檔的信息并閱讀、保存、修改后自用等等，但是不允許向外傳播的文件。公開(kāi)：項(xiàng)目組開(kāi)發(fā)過(guò)程中的自用文檔或面向售前工作的部分項(xiàng)目介紹材料等。修訂頁(yè)：記錄文件的修訂歷史，所有程序文件、除了表格以外的模板和記錄都需要

有變更履歷，一般位于程序文件的第二頁(yè)。版本標(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ī)則過(guò)程域與英文標(biāo)識(shí)對(duì)應(yīng)表：過(guò)程類別OSP定義的過(guò)程域英文標(biāo)識(shí)過(guò)程管理組織過(guò)程聚焦OPF組織過(guò)程定義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項(xiàng)目研發(fā)需求開(kāi)發(fā)與管理RDM系統(tǒng)設(shè)計(jì)編碼TS產(chǎn)品集成PI測(cè)試TST評(píng)審Review項(xiàng)目實(shí)施與驗(yàn)收VAL過(guò)程支持配置管理CM過(guò)程和產(chǎn)品質(zhì)量保證PPQA度量與分析MA決策分析和決定DAR文檔類型與英文標(biāo)識(shí)對(duì)應(yīng)表：序號(hào)文檔類型文檔標(biāo)識(shí)

1過(guò)程PROC2規(guī)程、規(guī)范、指南REGU3模板、記錄表格、工具TEMP文檔編號(hào)編寫(xiě)規(guī)則：規(guī)則公司名縮寫(xiě)過(guò)程域標(biāo)識(shí)文檔類型標(biāo)識(shí)文件名稱英文縮寫(xiě)或者拼音首字說(shuō)明公司名稱縮寫(xiě)為GF舉例風(fēng)險(xiǎn)數(shù)據(jù)表（RSKD）,屬于項(xiàng)目管理過(guò)程域的模板，過(guò)程域標(biāo)識(shí)為RSKM，文檔類型標(biāo)識(shí)為T(mén)EMP，文件名稱英文縮寫(xiě)為RSKD，則該文檔編號(hào)為：GF_RSKM_TEMP_RSKD文檔命名規(guī)范公司所有項(xiàng)目及項(xiàng)目?jī)?nèi)所有技術(shù)文檔應(yīng)按照以下規(guī)范進(jìn)行統(tǒng)一命名5.1.項(xiàng)目命名項(xiàng)目命名規(guī)則客戶簡(jiǎn)稱-項(xiàng)目產(chǎn)品舉例項(xiàng)目編號(hào)規(guī)則客戶英文簡(jiǎn)稱（或漢語(yǔ)拼音簡(jiǎn)稱）-產(chǎn)品英文簡(jiǎn)稱舉例GDYD-PORTAL說(shuō)明客戶英文簡(jiǎn)稱（或漢語(yǔ)拼音簡(jiǎn)稱）及產(chǎn)品英文簡(jiǎn)稱應(yīng)避免重名5.2.項(xiàng)目文檔命名項(xiàng)目文檔命名規(guī)則項(xiàng)目編號(hào)—文件名稱舉例項(xiàng)目編號(hào)為GDYD-PORTAL,項(xiàng)目文件名為風(fēng)險(xiǎn)數(shù)據(jù)表，則改文檔名為：GDYD-PORTAL_風(fēng)險(xiǎn)數(shù)據(jù)表說(shuō)明如果遇到重名情況，可在表后面直接添加相關(guān)能夠區(qū)分的標(biāo)志（姓名，日期等）。如：GDYD-PORTAL_個(gè)人工作周報(bào)20XXW20項(xiàng)目文檔中的文項(xiàng)目名稱件編號(hào)命名規(guī)則舉例項(xiàng)目名稱：那么項(xiàng)目文件中的文件編號(hào)為：文件結(jié)構(gòu)規(guī)定所有記錄中除表格之外的文件，在編制過(guò)程中應(yīng)按照相關(guān)編制規(guī)范編寫(xiě)。Word文件Word文件包括：封面、修訂頁(yè)、目錄、頁(yè)眉、頁(yè)腳和正文。?頁(yè)碼：封面為頁(yè)碼第一頁(yè)，頁(yè)碼由封面后第一頁(yè)開(kāi)始顯示，顯示在頁(yè)腳，格式為第X頁(yè)共Y頁(yè)（其中X,Y均為阿拉伯?dāng)?shù)字）；?頁(yè)眉：頁(yè)眉內(nèi)容左側(cè)為公司logo，右側(cè)為本文檔的文件名稱，設(shè)置首頁(yè)不同；頁(yè)腳：頁(yè)腳內(nèi)容左側(cè)為公司名中文全稱，右側(cè)為頁(yè)碼，設(shè)置首頁(yè)不同；?頁(yè)面設(shè)置：除個(gè)別特殊需要以外，紙型設(shè)為縱向A4,頁(yè)邊距采用默認(rèn)值（上下均為2.54cm，左右均為3.17cm）；密級(jí)：文檔封面的右上角標(biāo)識(shí)宋體五號(hào)加粗字體的密級(jí)，帶黑色細(xì)線文本框；文件屬性：填寫(xiě)文件屬性中的作者、文件名稱、公司名稱；文件更改摘要：宋體5號(hào)字，版本號(hào)標(biāo)識(shí)為0.1；正文：文件正文宋體5號(hào)字，每段開(kāi)始縮進(jìn)兩個(gè)漢字，使用1.5倍行距；一級(jí)標(biāo)題：使用樣式庫(kù)中的標(biāo)題一（宋體四號(hào)字加粗黑色）二級(jí)標(biāo)題：使用樣式庫(kù)中的標(biāo)題二（宋體小四號(hào)字加粗黑色）三級(jí)標(biāo)題：使用樣式庫(kù)中的標(biāo)題三（宋體小四號(hào)字加粗黑色）四級(jí)標(biāo)題：使用樣式庫(kù)中的標(biāo)題四（宋體五號(hào)字加粗黑色）；目錄：宋體五號(hào)字不加粗不使用斜體，段落間距：段前段后均設(shè)為0，行距設(shè)置為單倍行距；表格標(biāo)題：表格標(biāo)題宋體五號(hào)字加粗中對(duì)齊；引用文件：所有文中出現(xiàn)的文件名稱均有書(shū)名號(hào)；填寫(xiě)說(shuō)明：模板文件在需要填寫(xiě)的內(nèi)容給出填寫(xiě)說(shuō)明。Excel文件Excel文件包括：封面、修訂頁(yè)、正文。密級(jí)：文檔封面的右上角標(biāo)識(shí)宋體10號(hào)加粗字體的密級(jí)，帶黑色細(xì)線文本框；?表單：所有sheet的名稱都正確命名，空白表單刪除；?頁(yè)眉頁(yè)腳：清除頁(yè)眉頁(yè)腳的內(nèi)容；文件屬性：填寫(xiě)作者、文件名稱、公司名稱；文件更改摘要：宋體10號(hào)字，版本號(hào)標(biāo)識(shí)為V0.1；正文表格：使用宋體10號(hào)字；正文表格標(biāo)題：使用加粗宋體12號(hào)字；如需打印的文件，使用加粗宋體18號(hào)字表格邊框：使用細(xì)實(shí)線；選擇項(xiàng)：模板文件對(duì)于固定選項(xiàng)的字段使用下拉列表提供選擇；自動(dòng)匯總：模板文件對(duì)于統(tǒng)計(jì)結(jié)果字段設(shè)置成為自動(dòng)匯總；?填寫(xiě)說(shuō)明：模板文件在重要的需要填寫(xiě)的內(nèi)容給出填寫(xiě)說(shuō)明。封面XXX過(guò)程XXX公司文件編號(hào)當(dāng)前版本機(jī)密等級(jí)編制者審核者批準(zhǔn)者批準(zhǔn)日期XXXXXX有限公司對(duì)本文件資料享受著作權(quán)及其它專屬權(quán)利，未經(jīng)書(shū)面許

可，不得將該等文件資料（其全部或任何部分）披露予任何第三方，或進(jìn)行修改

后使用。文件更改摘要文件更改摘要內(nèi)容建議包括：版本號(hào)、修改日期、作者（修改人）、修訂說(shuō)明等，如下表所示，可以根據(jù)實(shí)際情況添加內(nèi)容。注意，在由模板文件生成實(shí)際組織或項(xiàng)目文件后，文件更改摘要頁(yè)中的原修訂記錄必須清除，改為實(shí)際文件的修訂記錄。文件更改摘要中的版本和作者要與封面的版本和編制一致。正式發(fā)布前（版本1.0）之前無(wú)需填寫(xiě)批準(zhǔn)人。修訂頁(yè)9.版本標(biāo)識(shí)根據(jù)產(chǎn)品的需要，軟件產(chǎn)品制造過(guò)程中的每個(gè)配置項(xiàng)和不同階段的基線發(fā)布都需要進(jìn)行相應(yīng)的版本標(biāo)識(shí)，下面分別作以介紹。9.1.管理文件版本標(biāo)識(shí)：版本的基準(zhǔn)格式為：x.y新起草的文件版本定為0.1版。逐步完善的文件但還沒(méi)有通過(guò)評(píng)審的，版本每次升級(jí)加0.1，但必須小于1.0版。通過(guò)正式評(píng)審的文件版本升級(jí)為1.0版，可對(duì)外發(fā)布。成為基準(zhǔn)的文件如有少量修改，可視情況升級(jí)為l.y版，“y”可根據(jù)次數(shù)依次遞增，取值范圍為“1~9”。如有實(shí)質(zhì)性的改變時(shí)，文件的版本升級(jí)為2.0版，依此類推，“y”可依次遞增，取值范圍為“1~9”。管理文件發(fā)布標(biāo)識(shí)圖：配置項(xiàng)版本標(biāo)識(shí)：未成為基準(zhǔn)的配置項(xiàng)的版本的取值范圍為：“0.01~0.99版”成為基準(zhǔn)的配置項(xiàng)的版本為Ver1.00版。如果今后有修正，從Ver1.01逐漸遞增。對(duì)于從其他產(chǎn)品繼承來(lái)的配置項(xiàng)，在原來(lái)配置項(xiàng)版本的基礎(chǔ)上作適當(dāng)?shù)膶?duì)應(yīng)。例如：如果以前的配置項(xiàng)為Verl.00，在本次項(xiàng)目中基本沒(méi)有修改的，維持原來(lái)的配置號(hào)；如果有大的增加，此配置項(xiàng)以1為本項(xiàng)目的增加幅度，在本項(xiàng)目中最終增為Ver2.00,以后以此類推。配置項(xiàng)標(biāo)識(shí)圖：基線版本標(biāo)識(shí)：配置管理員負(fù)責(zé)把基線發(fā)布給外部客戶(如發(fā)布運(yùn)行基線)或內(nèi)部使用(如為測(cè)試而發(fā)布)。最初基線版本創(chuàng)建：基線的類型見(jiàn)《配置管理過(guò)程》，最初的基線版本為1.00?；€變更時(shí)的版本：?當(dāng)基線發(fā)生變更時(shí)，我們可定義它的版本逐漸遞增。?當(dāng)內(nèi)容部份有少量變化，不影響其功能時(shí)，版本可在x.00<x.yy<x.99間變化。?當(dāng)發(fā)生功能性的變化時(shí)，如新增功能、功能完全改變、模式