(完整word版)產(chǎn)品開發(fā)項(xiàng)目文檔管理規(guī)范

1、 產(chǎn)品開發(fā)項(xiàng)目文檔管理規(guī)范文檔編號(hào)：coship-cmmi-prd-pdpdm密級(jí)：機(jī)密版本信息：1.8批準(zhǔn)日期：編輯軟件：microsoft word2003 microsoft visio 2003同洲電子股份有限公司版權(quán)所有內(nèi)部資料 注意保密文檔修訂記錄序號(hào)1v1.0c23v1.5v1.8mm2007-11-92007-11-20*變化狀態(tài)：c創(chuàng)建，a增加，m修改，d刪除文檔審批信息過程改進(jìn)組版本會(huì)簽批 準(zhǔn)備注（epg）審核 目 錄1 概述 11.1 目的 11.2 適用范圍 12 產(chǎn)品開發(fā)文檔體系 13 文檔質(zhì)量的度量準(zhǔn)則 34 主要角色和職責(zé) 34.1 文檔作者 34.2 項(xiàng)目經(jīng)理

2、44.3ppqa44.4 配置管理工程師 44.5 評(píng)審組 44.6 部門經(jīng)理 45 文檔審核流程 55.1 審核流程 55.2 歸檔簽名 65.3 納入基線 66 文檔保密制度 77 文檔編號(hào) 77.1 文檔編號(hào)規(guī)則 77.2 階段代號(hào) 88 文檔版本 9 1 概述1.1 目的規(guī)范公司產(chǎn)品開發(fā)項(xiàng)目的文檔體系，加強(qiáng)文檔的標(biāo)準(zhǔn)化管理。1.2 適用范圍公司內(nèi)所有產(chǎn)品開發(fā)項(xiàng)目。2 產(chǎn)品開發(fā)文檔體系在產(chǎn)品開發(fā)項(xiàng)目開發(fā)過程中，各階段都有相應(yīng)的文檔輸出，文檔的編寫應(yīng)先于或同步于開發(fā)工作。產(chǎn)品開發(fā)項(xiàng)目過程中的文檔體系如表 1 所示。表1. 產(chǎn)品開發(fā)項(xiàng)目文檔體系序號(hào)文檔名稱123項(xiàng)目經(jīng)理項(xiàng)目經(jīng)理項(xiàng)目經(jīng)理456

3、789需求分析師軟件工程師硬件工程師結(jié)構(gòu)工程師電源工程師項(xiàng)目經(jīng)理計(jì)劃系統(tǒng)設(shè)計(jì)師系統(tǒng)總體設(shè)計(jì)說明書10 項(xiàng)目計(jì)劃書質(zhì)量保證計(jì)劃配置管理計(jì)劃進(jìn)度計(jì)劃11項(xiàng)目經(jīng)理ppqa14151617軟件模塊詳細(xì)設(shè)計(jì)說明書18軟件工程師單元測試計(jì)劃單元測試用例單元測試報(bào)告電路原理圖pcb 設(shè)計(jì)圖結(jié)構(gòu)圖紙192021222324252627282930軟件工程師軟件工程師軟件工程師硬件工程師pcb結(jié)構(gòu)工程師硬件工程師項(xiàng)目經(jīng)理bom產(chǎn)品集成計(jì)劃集成測試計(jì)劃接口說明書集成測試用例集成測試報(bào)告項(xiàng)目經(jīng)理軟件工程師軟件工程師軟件工程師3132333435測試工程師測試工程師測試工程師測試工程師測試工程師驗(yàn)證測試報(bào)告回歸測試報(bào)

4、告缺陷報(bào)告36373839用戶使用文檔項(xiàng)目總結(jié)報(bào)告項(xiàng)目結(jié)項(xiàng)表單4041項(xiàng)目經(jīng)理項(xiàng)目經(jīng)理 系統(tǒng)測試報(bào)告產(chǎn)品缺陷列表4243測試工程師測試工程師3 文檔質(zhì)量的度量準(zhǔn)則評(píng)審文檔質(zhì)量的度量準(zhǔn)則有以下六條：完整性：所承擔(dān)產(chǎn)品開發(fā)任務(wù)的項(xiàng)目組，需按照公司文檔體系的規(guī)定編寫相應(yīng)的文檔，以保證在項(xiàng)目結(jié)束時(shí)其文檔是齊全的。正確性：在項(xiàng)目各個(gè)階段所編寫的文檔的內(nèi)容，必須真實(shí)的反映階段的工作且與該階段的需求相一致。文檔與所述的對(duì)象保持一致，必要時(shí)應(yīng)進(jìn)行實(shí)時(shí)的文檔版本升級(jí)?？勺x性：文檔應(yīng)該表達(dá)清晰、邏輯條理分明、表現(xiàn)形式通用。簡明性：在項(xiàng)目各個(gè)階段所編寫的各種文檔的語言表達(dá)應(yīng)該準(zhǔn)確簡練。規(guī)范性：文檔的規(guī)范性是指采用當(dāng)

5、前最新的模板。其完整性及內(nèi)容的充實(shí)程度應(yīng)不低于模板的要求?？勺匪菪裕涸陧?xiàng)目各個(gè)階段所編寫的各種文檔應(yīng)該具有良好的可追溯性。由于各開發(fā)階段編制的文檔與各階段完成的工作有著密切的關(guān)系，前后階段生成的文件，隨著開發(fā)工作的逐步擴(kuò)展，具有一定的繼承關(guān)系。在一個(gè)項(xiàng)目各開發(fā)階段之間提供的文件必定存在著可追溯的關(guān)系。4 主要角色和職責(zé)4.1 文檔作者文檔作者包括公司內(nèi)的項(xiàng)目組成員以及外協(xié)人員。文檔作者在文檔方面的主要工作為：1） 在項(xiàng)目開發(fā)過程的各個(gè)階段中，按照規(guī)定及時(shí)地完成項(xiàng)目文檔的編寫工作，文檔作者有責(zé)任保證文檔編寫與開發(fā)同步。2） 文檔作者不僅要審核文檔字面上有無錯(cuò)漏，還要審核所陳述的技術(shù)內(nèi)容是否精確，

6、及表達(dá)方式上是否清晰易懂。文檔作者對(duì)文檔的正確性、可讀性和規(guī)范性全面負(fù)責(zé)。3） 文檔作者保證所編寫的文檔與所描述的對(duì)象保持很好的一致性，必要時(shí)及時(shí)更新文檔，便于以后維護(hù)工作和后續(xù)開發(fā)工作的開展。 4.2 項(xiàng)目經(jīng)理項(xiàng)目經(jīng)理是控制文檔準(zhǔn)確性的關(guān)鍵環(huán)節(jié)，項(xiàng)目經(jīng)理與文檔作者一起構(gòu)成文檔正確性的直接責(zé)任人。項(xiàng)目經(jīng)理在文檔方面的主要工作為：1） 項(xiàng)目經(jīng)理制定整個(gè)項(xiàng)目的文檔計(jì)劃（包含在項(xiàng)目計(jì)劃中），并督促落實(shí)文檔計(jì)劃的實(shí)施。2） 負(fù)責(zé)對(duì)技術(shù)內(nèi)容正確性的檢查并校對(duì)文檔內(nèi)容與所述對(duì)象最新版本是否保持一致。3） 定義項(xiàng)目文檔的密級(jí)。4.3 ppqappqa 的主要工作為：1） 對(duì)文檔作者提供的文檔進(jìn)行編號(hào)。2）

7、檢查項(xiàng)目各階段文檔計(jì)劃的執(zhí)行情況，確保文檔的三級(jí)審核制度得到執(zhí)行直至最后歸檔。3） 對(duì)文檔進(jìn)行規(guī)范性審查。4） 根據(jù)文檔計(jì)劃，組織評(píng)審組對(duì)文檔進(jìn)行評(píng)審。5） 確認(rèn)項(xiàng)目經(jīng)理定義的文檔密級(jí)，并確保文檔的保密性得到有效控制。4.4 配置管理工程師將評(píng)審?fù)ㄟ^或是部門經(jīng)理審核通過的文檔納入基線管理，根據(jù)密級(jí)確認(rèn)相應(yīng)的權(quán)限。4.5 評(píng)審組對(duì)需要評(píng)審的文檔（可行性研究報(bào)告、項(xiàng)目計(jì)劃書、需求規(guī)格說明書、概要設(shè)計(jì)書等）的內(nèi)容進(jìn)行質(zhì)量把關(guān)。4.6 部門經(jīng)理文檔作者所屬部門的部門經(jīng)理對(duì)不需評(píng)審的文檔進(jìn)行最終審核。 5 文檔審核流程對(duì)每一份文檔要求在納入基線前，從項(xiàng)目經(jīng)理、ppqa、部門經(jīng)理或評(píng)審組，進(jìn)行三級(jí)審核，這

8、樣，分別從文檔質(zhì)量的完備性、正確性、可讀性、簡明性、規(guī)范性、可追溯性等方面進(jìn)行分層把關(guān)，并最后簽字確認(rèn)其文檔質(zhì)量合格。產(chǎn)品開發(fā)項(xiàng)目的文檔管理層次結(jié)構(gòu)如圖 1 所示：5.1 審核流程產(chǎn)品開發(fā)項(xiàng)目文檔在歸檔前均要經(jīng)過多級(jí)審核，各審核一般都對(duì)應(yīng)到文檔封面的簽名。文檔的審核歸檔流程如圖 2 所示。 內(nèi)容一審項(xiàng)目經(jīng)理nnynnynyyy納入基線配置管理工程師圖 2 文檔的審核流程5.2 歸檔簽名開發(fā)階段文檔在納入基線之前需要經(jīng)過三級(jí)審批，包括文檔作者在內(nèi)共四級(jí)簽名： 文檔作者：為文檔的主要思想提供者和寫作者。如果有多人參與，則記錄主要人員。 項(xiàng)目經(jīng)理：為在立項(xiàng)評(píng)審時(shí)指定的項(xiàng)目負(fù)責(zé)人。 審核：ppqa。

9、批準(zhǔn)：如果此文檔需評(píng)審，則批準(zhǔn)人為評(píng)審組長；否則為文檔作者所屬部門的部門經(jīng)理。5.3 納入基線產(chǎn)品開發(fā)項(xiàng)目文檔在經(jīng)過三級(jí)審批通過后，由配置管理工程師納入基線進(jìn)行管理。 6 文檔保密制度為確保產(chǎn)品開發(fā)項(xiàng)目文檔的安全性，防止技術(shù)資料的外泄以及維護(hù)公司的權(quán)益，對(duì)每種文檔還應(yīng)劃定它們各自的保密級(jí)別。每份文檔的密級(jí)原則上根據(jù)其所含技術(shù)的保密要求以及產(chǎn)品進(jìn)入市場的程度，由項(xiàng)目經(jīng)理負(fù)責(zé)指定。文檔是按照與開發(fā)同步的原則寫作，所以大多數(shù)文檔在第一次納入基線時(shí)，其密級(jí)一般為“機(jī)密”，然后隨著產(chǎn)品的逐漸成熟，其保密程度會(huì)逐漸放開，所以每份文檔的密級(jí)標(biāo)志是動(dòng)態(tài)的。納入基線后的文檔密級(jí)若需要改變，可由項(xiàng)目經(jīng)理提出申請(qǐng)，

10、配置管理工程師責(zé)對(duì)文檔所在配置庫重新分配權(quán)限。文檔密級(jí)共分為四級(jí)： 絕密：指只有極少數(shù)人可以查閱的文檔。如：核心技術(shù)的文檔、預(yù)研項(xiàng)目的文檔等。此類文檔應(yīng)嚴(yán)格保密，配置庫權(quán)限一般只分配給研發(fā)領(lǐng)導(dǎo)指定人員，須簽訂保密協(xié)議。 機(jī)密：指只有項(xiàng)目組的人可以查閱的文檔。如：軟件概要設(shè)計(jì)說明書、硬件概要設(shè)計(jì)說明書等。對(duì)此類文檔，配置庫權(quán)限分配給項(xiàng)目組成員，其他人如需申請(qǐng)權(quán)限，需經(jīng)項(xiàng)目經(jīng)理批準(zhǔn)。 普通：指在公司范圍內(nèi)開放的文檔。如：產(chǎn)品規(guī)格等。此類文檔可在公司范圍內(nèi)進(jìn)行傳閱。 公開：指對(duì)外開放的文檔。如：產(chǎn)品說明書及相關(guān)宣傳資料等。對(duì)此類文檔不做權(quán)限控制。以上密級(jí)歸類僅供參考，各項(xiàng)目經(jīng)理應(yīng)根據(jù)產(chǎn)品競爭策略需要

11、等實(shí)際情況確定歸入哪個(gè)密級(jí)，做到在保密基礎(chǔ)上的資源共享。7 文檔編號(hào)文檔以產(chǎn)品和項(xiàng)目為單位進(jìn)行劃分，對(duì)每篇文檔根據(jù)其所屬產(chǎn)品、項(xiàng)目和具體描述內(nèi)容定義一個(gè)唯一的編號(hào)。文檔編號(hào)由 ppqa 分配。注：硬件原理圖、pcb 圖、結(jié)構(gòu)圖紙、bom 等文件編碼不在此編號(hào)范圍內(nèi)。7.1 文檔編號(hào)規(guī)則文檔編號(hào)由五部分組成，各部分由-分隔，其構(gòu)成如下：產(chǎn)品型號(hào)_項(xiàng)目編號(hào)_階段代號(hào)_模塊代號(hào)對(duì)文檔進(jìn)行編號(hào)時(shí)，各組成部分最好都有對(duì)應(yīng)的代號(hào)及含義。如果不需區(qū)分模塊，則以&代替模塊代號(hào)。 其中： 產(chǎn)品型號(hào)：一般對(duì)應(yīng)于產(chǎn)品型號(hào)（外部型號(hào)）。 項(xiàng)目編號(hào)：所開發(fā)產(chǎn)品的項(xiàng)目編號(hào)。 階段代號(hào)：此文檔對(duì)應(yīng)的項(xiàng)目階段代號(hào)，請(qǐng)參見7.

12、2。 模塊代號(hào)：軟件功能模塊或硬件單板的縮寫。如：新華社項(xiàng)目設(shè)計(jì)階段的設(shè)計(jì)文檔 mpe 模塊概要設(shè)計(jì)書的文檔標(biāo)號(hào)為：cdvb5110g_dc-p071114-21_pd.sw_mpe。7.2 階段代號(hào)階段代號(hào)由 24 位英文字母和一位“.”字符表示，構(gòu)成如下：主階段代號(hào).子階段代號(hào)12 位 12 位例如，“可行性研究報(bào)告”文檔對(duì)應(yīng)的階段編號(hào)為 i.r,“系統(tǒng)測試計(jì)劃”文檔對(duì)應(yīng)的階段代號(hào)為 sa.tp。文檔各階段代號(hào)如表 2 所示。表2. 文檔階段代號(hào)文檔名稱i(initialization)立項(xiàng)i(initialization)i(initialization)r(requirement）r(

13、requirement）r(requirement）r(requirement）r(requirement）r(requirement）p(planning)s(system)sw(software)hw(hardware)st(structure)需求計(jì)劃qa(quality assurance)cm(configuration management)s(schedule)設(shè)計(jì)實(shí)現(xiàn)結(jié)構(gòu)概要設(shè)計(jì)說明書軟件詳細(xì)設(shè)計(jì)說明書單元測試計(jì)劃書單元測試用例im(implementation)im(implementation)im(implementation)sw(software)up(unit testing plan)uc(unit testing case) v(validation)驗(yàn)證v(validation)v(validation)at(authentication testing)tr(testing report)v(validation)v(validation)發(fā)布p