文檔編寫規(guī)范_第1頁
文檔編寫規(guī)范_第2頁
文檔編寫規(guī)范_第3頁
文檔編寫規(guī)范_第4頁
文檔編寫規(guī)范_第5頁
已閱讀5頁,還剩8頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)

文檔簡介

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

有變更履歷,一般位于程序文件的第二頁。版本標識:作為文檔的版本區(qū)分。所有發(fā)布版本之前不得大于1.0,發(fā)布版本作為1.0,而其后只有重大修改可以調(diào)整小數(shù)點前的版本號,局部修改調(diào)整小數(shù)點后版本號,并在修訂記錄表中保留記錄。文檔編號規(guī)則過程域與英文標識對應(yīng)表:過程類別OSP定義的過程域英文標識過程管理組織過程聚焦OPF組織過程定義OPD組織培訓(xùn)OT項目管理立項PIM集成項目管理IPM項目策劃PP項目監(jiān)督和控制PMC風險管理RSKM結(jié)項PCM項目研發(fā)需求開發(fā)與管理RDM系統(tǒng)設(shè)計編碼TS產(chǎn)品集成PI測試TST評審Review項目實施與驗收VAL過程支持配置管理CM過程和產(chǎn)品質(zhì)量保證PPQA度量與分析MA決策分析和決定DAR文檔類型與英文標識對應(yīng)表:序號文檔類型文檔標識

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

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

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

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論