產(chǎn)品開發(fā)文檔規(guī)范

1、產(chǎn)品開發(fā)項目文檔管理規(guī)范文檔編號：coship-cmmi-prd-pdpdm密級：機密版本信息：1.8批準日期：編輯軟件：microsoft word 2003 microsoft visio 2003同洲電子股份有限公司 版權(quán)所有內(nèi)部資料 注意保密文檔修訂記錄序號版本編號變化狀態(tài)變更（+/-）說明作者日期1v1.0c2004年2v1.5m根據(jù)實際情況進行優(yōu)化階段代號和文檔密級等王巖2007-11-93v1.8m根據(jù)評審意見進行修改王巖2007-11-20*變化狀態(tài)：c創(chuàng)建，a增加，m修改，d刪除文檔審批信息版本過程改進組（epg）審核會簽批 準備 注目 錄1概述11.1目的11.2適用范圍1

2、2產(chǎn)品開發(fā)文檔體系13文檔質(zhì)量的度量準則34主要角色和職責(zé)34.1文檔作者34.2項目經(jīng)理44.3ppqa44.4配置管理工程師44.5評審組44.6部門經(jīng)理45文檔審核流程55.1審核流程55.2歸檔簽名65.3納入基線66文檔保密制度77文檔編號77.1文檔編號規(guī)則77.2階段代號88文檔版本91 概述1.1 目的規(guī)范公司產(chǎn)品開發(fā)項目的文檔體系，加強文檔的標準化管理。1.2 適用范圍公司內(nèi)所有產(chǎn)品開發(fā)項目。2 產(chǎn)品開發(fā)文檔體系在產(chǎn)品開發(fā)項目開發(fā)過程中，各階段都有相應(yīng)的文檔輸出，文檔的編寫應(yīng)先于或同步于開發(fā)工作。產(chǎn)品開發(fā)項目過程中的文檔體系如表1所示。表1. 產(chǎn)品開發(fā)項目文檔體系序號文檔名稱

3、文檔作者備注立項1可行性研究報告項目經(jīng)理2產(chǎn)品規(guī)格書項目經(jīng)理3立項報告項目經(jīng)理需求4系統(tǒng)需求規(guī)格說明書需求分析師5軟件需求規(guī)格說明書軟件工程師6硬件需求規(guī)格說明書硬件工程師7結(jié)構(gòu)需求表結(jié)構(gòu)工程師8電源需求規(guī)格說明書電源工程師9需求管理矩陣項目經(jīng)理計劃10系統(tǒng)總體設(shè)計說明書系統(tǒng)設(shè)計師11項目計劃書項目經(jīng)理12 1質(zhì)量保證計劃ppqa13配置管理計劃配置管理工程師14進度計劃項目經(jīng)理設(shè)計15軟件概要設(shè)計說明書軟件工程師16結(jié)構(gòu)概要設(shè)計說明書結(jié)構(gòu)工程師17硬件概要設(shè)計說明書硬件工程師實現(xiàn)18軟件模塊詳細設(shè)計說明書軟件工程師19單元測試計劃軟件工程師20單元測試用例軟件工程師21單元測試報告軟件工程師

4、22電路原理圖硬件工程師23pcb設(shè)計圖pcb設(shè)計工程師24結(jié)構(gòu)圖紙結(jié)構(gòu)工程師25bom 硬件工程師研發(fā)bom26產(chǎn)品集成計劃項目經(jīng)理27集成測試計劃項目經(jīng)理28接口說明書軟件工程師29集成測試用例軟件工程師30集成測試報告軟件工程師驗證31系統(tǒng)測試計劃測試工程師32系統(tǒng)測試用例測試工程師33產(chǎn)品缺陷列表測試工程師34認證性測試報告測試工程師研發(fā)中心出具35系統(tǒng)測試報告測試工程師發(fā)布36驗證測試報告認證代表37回歸測試報告測試工程師38缺陷報告測試工程師39用戶使用文檔技術(shù)資料工程師交付結(jié)項40項目總結(jié)報告項目經(jīng)理41項目結(jié)項表單項目經(jīng)理42系統(tǒng)測試報告測試工程師43產(chǎn)品缺陷列表測試工程師3

5、文檔質(zhì)量的度量準則評審文檔質(zhì)量的度量準則有以下六條：完整性：所承擔(dān)產(chǎn)品開發(fā)任務(wù)的項目組，需按照公司文檔體系的規(guī)定編寫相應(yīng)的文檔，以保證在項目結(jié)束時其文檔是齊全的。正確性：在項目各個階段所編寫的文檔的內(nèi)容，必須真實的反映階段的工作且與該階段的需求相一致。文檔與所述的對象保持一致，必要時應(yīng)進行實時的文檔版本升級?？勺x性：文檔應(yīng)該表達清晰、邏輯條理分明、表現(xiàn)形式通用。簡明性：在項目各個階段所編寫的各種文檔的語言表達應(yīng)該準確簡練。規(guī)范性：文檔的規(guī)范性是指采用當前最新的模板。其完整性及內(nèi)容的充實程度應(yīng)不低于模板的要求?？勺匪菪裕涸陧椖扛鱾€階段所編寫的各種文檔應(yīng)該具有良好的可追溯性。由于各開發(fā)階段編制的文

6、檔與各階段完成的工作有著密切的關(guān)系，前后階段生成的文件，隨著開發(fā)工作的逐步擴展，具有一定的繼承關(guān)系。在一個項目各開發(fā)階段之間提供的文件必定存在著可追溯的關(guān)系。4 主要角色和職責(zé)4.1 文檔作者文檔作者包括公司內(nèi)的項目組成員以及外協(xié)人員。文檔作者在文檔方面的主要工作為：1） 在項目開發(fā)過程的各個階段中，按照規(guī)定及時地完成項目文檔的編寫工作，文檔作者有責(zé)任保證文檔編寫與開發(fā)同步。2） 文檔作者不僅要審核文檔字面上有無錯漏，還要審核所陳述的技術(shù)內(nèi)容是否精確，及表達方式上是否清晰易懂。文檔作者對文檔的正確性、可讀性和規(guī)范性全面負責(zé)。3） 文檔作者保證所編寫的文檔與所描述的對象保持很好的一致性，必要時及

7、時更新文檔，便于以后維護工作和后續(xù)開發(fā)工作的開展。4.2 項目經(jīng)理項目經(jīng)理是控制文檔準確性的關(guān)鍵環(huán)節(jié)，項目經(jīng)理與文檔作者一起構(gòu)成文檔正確性的直接責(zé)任人。項目經(jīng)理在文檔方面的主要工作為：1） 項目經(jīng)理制定整個項目的文檔計劃（包含在項目計劃中），并督促落實文檔計劃的實施。2） 負責(zé)對技術(shù)內(nèi)容正確性的檢查并校對文檔內(nèi)容與所述對象最新版本是否保持一致。3） 定義項目文檔的密級。4.3 ppqappqa的主要工作為：1） 對文檔作者提供的文檔進行編號。2） 檢查項目各階段文檔計劃的執(zhí)行情況，確保文檔的三級審核制度得到執(zhí)行直至最后歸檔。3） 對文檔進行規(guī)范性審查。4） 根據(jù)文檔計劃，組織評審組對文檔進行評

8、審。5） 確認項目經(jīng)理定義的文檔密級，并確保文檔的保密性得到有效控制。4.4 配置管理工程師將評審?fù)ㄟ^或是部門經(jīng)理審核通過的文檔納入基線管理，根據(jù)密級確認相應(yīng)的權(quán)限。4.5 評審組對需要評審的文檔（可行性研究報告、項目計劃書、需求規(guī)格說明書、概要設(shè)計書等）的內(nèi)容進行質(zhì)量把關(guān)。4.6 部門經(jīng)理文檔作者所屬部門的部門經(jīng)理對不需評審的文檔進行最終審核。5 文檔審核流程對每一份文檔要求在納入基線前，從項目經(jīng)理、ppqa、部門經(jīng)理或評審組，進行三級審核，這樣，分別從文檔質(zhì)量的完備性、正確性、可讀性、簡明性、規(guī)范性、可追溯性等方面進行分層把關(guān)，并最后簽字確認其文檔質(zhì)量合格。產(chǎn)品開發(fā)項目的文檔管理層次結(jié)構(gòu)如

9、圖1所示：評審組部門經(jīng)理ppqa項目經(jīng)理文檔作者圖1 文檔管理層次結(jié)構(gòu)5.1 審核流程產(chǎn)品開發(fā)項目文檔在歸檔前均要經(jīng)過多級審核，各審核一般都對應(yīng)到文檔封面的簽名。文檔的審核歸檔流程如圖2所示。圖2 文檔的審核流程5.2 歸檔簽名開發(fā)階段文檔在納入基線之前需要經(jīng)過三級審批，包括文檔作者在內(nèi)共四級簽名： 文檔作者：為文檔的主要思想提供者和寫作者。如果有多人參與，則記錄主要人員。 項目經(jīng)理：為在立項評審時指定的項目負責(zé)人。 審核：ppqa。 批準：如果此文檔需評審，則批準人為評審組長；否則為文檔作者所屬部門的部門經(jīng)理。5.3 納入基線產(chǎn)品開發(fā)項目文檔在經(jīng)過三級審批通過后，由配置管理工程師納入基線進行

10、管理。6 文檔保密制度為確保產(chǎn)品開發(fā)項目文檔的安全性，防止技術(shù)資料的外泄以及維護公司的權(quán)益，對每種文檔還應(yīng)劃定它們各自的保密級別。每份文檔的密級原則上根據(jù)其所含技術(shù)的保密要求以及產(chǎn)品進入市場的程度，由項目經(jīng)理負責(zé)指定。文檔是按照與開發(fā)同步的原則寫作，所以大多數(shù)文檔在第一次納入基線時，其密級一般為“機密”，然后隨著產(chǎn)品的逐漸成熟，其保密程度會逐漸放開，所以每份文檔的密級標志是動態(tài)的。納入基線后的文檔密級若需要改變，可由項目經(jīng)理提出申請，配置管理工程師責(zé)對文檔所在配置庫重新分配權(quán)限。文檔密級共分為四級： 絕密：指只有極少數(shù)人可以查閱的文檔。如：核心技術(shù)的文檔、預(yù)研項目的文檔等。此類文檔應(yīng)嚴格保密，

11、配置庫權(quán)限一般只分配給研發(fā)領(lǐng)導(dǎo)指定人員，須簽訂保密協(xié)議。 機密：指只有項目組的人可以查閱的文檔。如：軟件概要設(shè)計說明書、硬件概要設(shè)計說明書等。對此類文檔，配置庫權(quán)限分配給項目組成員，其他人如需申請權(quán)限，需經(jīng)項目經(jīng)理批準。 普通：指在公司范圍內(nèi)開放的文檔。如：產(chǎn)品規(guī)格等。此類文檔可在公司范圍內(nèi)進行傳閱。 公開：指對外開放的文檔。如：產(chǎn)品說明書及相關(guān)宣傳資料等。對此類文檔不做權(quán)限控制。以上密級歸類僅供參考，各項目經(jīng)理應(yīng)根據(jù)產(chǎn)品競爭策略需要等實際情況確定歸入哪個密級，做到在保密基礎(chǔ)上的資源共享。7 文檔編號文檔以產(chǎn)品和項目為單位進行劃分，對每篇文檔根據(jù)其所屬產(chǎn)品、項目和具體描述內(nèi)容定義一個唯一的編號

12、。文檔編號由ppqa分配。注：硬件原理圖、pcb圖、結(jié)構(gòu)圖紙、bom等文件編碼不在此編號范圍內(nèi)。7.1 文檔編號規(guī)則文檔編號由五部分組成，各部分由-分隔，其構(gòu)成如下：產(chǎn)品型號_項目編號_階段代號_模塊代號 對文檔進行編號時，各組成部分最好都有對應(yīng)的代號及含義。如果不需區(qū)分模塊，則以&代替模塊代號。其中： 產(chǎn)品型號：一般對應(yīng)于產(chǎn)品型號（外部型號）。 項目編號：所開發(fā)產(chǎn)品的項目編號。 階段代號：此文檔對應(yīng)的項目階段代號，請參見7.2。 模塊代號：軟件功能模塊或硬件單板的縮寫。如：新華社項目設(shè)計階段的設(shè)計文檔mpe模塊概要設(shè)計書的文檔標號為：cdvb5110g_ dc-p071114-21_pd.s

13、w_mpe。7.2 階段代號階段代號由24位英文字母和一位“.”字符表示，構(gòu)成如下：主階段代號.子階段代號 12位 12位例如，“可行性研究報告”文檔對應(yīng)的階段編號為i.r,“系統(tǒng)測試計劃”文檔對應(yīng)的階段代號為sa.tp。文檔各階段代號如表2所示。表2. 文檔階段代號項目階段文檔名稱主階段代號子階段代號立項可行性研究報告i(initialization)f(feasibility)產(chǎn)品規(guī)格說明書i(initialization)s(specification)立項報告i(initialization)r(report)需求系統(tǒng)需求規(guī)格說明書r(requirement）s(system)軟件需求

14、規(guī)格說明書r(requirement）sw(software)硬件需求規(guī)格說明書r(requirement）hw(hardware)結(jié)構(gòu)需求表r(requirement）st(structure)電源需求規(guī)格說明書r(requirement）p(power)需求管理矩陣 r(requirement）m(management)計劃系統(tǒng)總體設(shè)計說明書p(planning)sl(solution)項目計劃書p(planning)i(integration)質(zhì)量保證計劃p(planning)qa(quality assurance)配置管理計劃p(planning)cm(configuration m

15、anagement)進度計劃p(planning)s(schedule)設(shè)計軟件概要設(shè)計說明書pd(preliminary design)sw(software)硬件概要設(shè)計說明書pd(preliminary design)hw(hardware)結(jié)構(gòu)概要設(shè)計說明書pd(preliminary design)st(structure)實現(xiàn)軟件詳細設(shè)計說明書im(implementation)sw(software)單元測試計劃書im(implementation)up(unit testing plan)單元測試用例im(implementation)uc(unit testing case)

16、單元測試報告im(implementation)ur(unit testing report)產(chǎn)品集成計劃im(implementation)ip(integration plan)集成測試計劃書im(implementation)tp(testing plan)接口說明書im(implementation)i(interface)集成測試用例im(implementation)tc(testing case)集成測試報告im(implementation)tr(testing report)驗證系統(tǒng)測試計劃書v(validation)tp(testing plan)系統(tǒng)測試用例v(validation)tc(testing case)產(chǎn)品缺陷列表v(validation)bl(buglist)認證性測試報告v(validation)at(authentication testing) 系統(tǒng)測試報告v(validation)tr(testing report)發(fā)布驗證測試報告rl(release)v(validation)回歸測試報告rl(release)tr (regression testing report)缺陷報告rl(release)bl(bug