產(chǎn)品開發(fā)項目文檔管

理規(guī)范V3.0

目錄

1概述...............1

1.1目的....................................1

1.2適用范圍...................................1

2產(chǎn)品開發(fā)文檔體系..............................................................1

3文檔質(zhì)量的度量準則...........................—.3

4主要角色和職責................................................................4

4.1文檔作者...............................................................4

4.2項目經(jīng)理...............................................................4

4.3PPQA.............................................................................................................5

4.4配置管理工程師.........................................................5

|???????????????????????????????????????????????????????????????????????????????????????????????????????3

4.6部門經(jīng)理……..........................................................5

5文檔審核流程...................................5

5.1審核流程..............................................................6

5.2歸檔簽名..............................................................7

5.3納入基線...............................................................8

6文檔保密制度................................................................8

7文檔編號......................................................................9

7.1文檔編號規(guī)則...........................................................9

7.2階段代號................................................................9

8文檔版本.....................................................

1概述

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所示。

產(chǎn)品開發(fā)項目文檔體系

序號文檔名稱文檔作者備注

立項

1可行性研究報告項目經(jīng)理

2產(chǎn)品規(guī)格書項目經(jīng)理

3立項報告項目經(jīng)理

需求

4系統(tǒng)需求規(guī)格說明書需求分析師

5軟件需求規(guī)格說明書軟件工程師

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文檔質(zhì)量的度量準則

評審文檔質(zhì)量的度量準則有以下六條：

完整性：所承擔產(chǎn)品開發(fā)任務(wù)的項目組，需按照公司文檔體系的規(guī)定編寫相應(yīng)的文檔，

以保證在項目結(jié)束時其文檔是齊全的。

正確性：在項目各個階段所編寫的文檔的內(nèi)容，必須真實的反映階段的工作且與該階段

的需求相一致。文檔與所述的對象保持一致，必要時應(yīng)進行實時的文檔版本升級。

可讀性：文檔應(yīng)該表達清晰、邏輯條理分明、表現(xiàn)形式通用。

簡明性：在項目各個階段所編寫的各種文檔的語言表達應(yīng)該準確簡練。

規(guī)范性：文檔的規(guī)范性是指采用當前最新的模板。其完整性及內(nèi)容的充實程度應(yīng)不低于

模板的要求。

可追溯性：在項目各個階段所編寫的各種文檔應(yīng)該具有良好的可追溯性。由于各開發(fā)階

段編制的文檔與各階段完成的工作有著密切的關(guān)系，前后階段生成的文件，隨著開發(fā)工作的

逐步擴展，具有一定的繼承關(guān)系。在一個項目各開發(fā)階段之間提供的文件必定存在著可追溯

的關(guān)系。

4主要角色和職責

4.1文檔作者

文檔作者包括公司內(nèi)的項目組成員以及外協(xié)人員。文檔作者在文檔方面的主要工作為：

1）在項目開發(fā)過程的各個階段中，按照規(guī)定及時地完成項目文檔的編寫工作，文檔

作者有責任保證文檔編寫與開發(fā)同步。

2）文檔作者不僅要審核文檔字面上有無錯漏，還要審核所陳述的技術(shù)內(nèi)容是否精確，

及表達方式上是否清晰易懂。文檔作者對文檔的正確性、可讀性和規(guī)范性全面負責。

3）文檔作者保證所編寫的文檔與所描述的對象保持很好的一致性，必要時及時更新

文檔，便于以后維護工作和后續(xù)開發(fā)工作的開展。

4.2項目經(jīng)理

項目經(jīng)理是控制文檔準確性的關(guān)鍵環(huán)節(jié)，項目經(jīng)理與文檔作者一起構(gòu)成文檔正確性的直

接責任人。

項目經(jīng)理在文檔方面的主要工作為：

1）項目經(jīng)理制定整個項目的文檔計劃（包含在項目計劃中），并督促落實文檔計劃

的實施。

2）負責對技術(shù)內(nèi)容正確性的檢杳并校對文檔內(nèi)容與所述對象最新版本是否保持一

致。

3）定義項目文檔的密級。

4.3PPQA

PPQA的主要工作為：

1）對文檔作者提供的文檔進行編號。

2）檢查項目各階段文檔計劃的執(zhí)行情況確保文檔的三級審核制度得到執(zhí)行直至最

后歸檔。

3）對文檔進行規(guī)范性審查。

4）根據(jù)文檔計劃，組織評審組對文檔進行評審。

5）確認項目經(jīng)理定義的文檔密級，并確保文檔的保密性得到有效控制。

4.4配置管理工程師

將評審通過或是部門經(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)如圖1所示：

圖1文檔管理層次結(jié)構(gòu)

5.1審核流程

產(chǎn)品開發(fā)項目文檔在歸檔前均要經(jīng)過多級審核，各審核一般都對應(yīng)到文檔封面的簽名。

文檔的審核歸檔流程如圖2所示。

圖2文檔的審核流程

5.2歸檔簽名

開發(fā)階段文檔在納入基線之前需要經(jīng)過三級審批，包括文檔作者在內(nèi)共四級簽名：

>文檔作者為文檔的主要思想提供者和寫作者。如果有多人參與則記錄主要人員。

>項目經(jīng)理：為在立項評審時指定的項目負責人。

>審核：PPQA。

>批準：如果此文檔需評審，則批準人為評審組長；否則為文檔作者所屬部門的部門

經(jīng)理。

5.3納入基線

產(chǎn)品開發(fā)項目文檔在經(jīng)過三級審批通過后，由配置管理工程師納入基線進行管理。

6文檔保密制度

為確保產(chǎn)品開發(fā)項目文檔的安全性，防止技術(shù)資料的外泄以及維護公司的權(quán)益，對每種

文檔還應(yīng)劃定它們各自的保密級別。

每份文檔的密級原則上根據(jù)其所含技術(shù)的保密要求以及產(chǎn)品進入市場的程度，由項目經(jīng)

理負責指定。文檔是按照與開發(fā)同步的原則寫作，所以大多數(shù)文檔在第一次納入基線時，其

密級一般為"機密"，然后隨著產(chǎn)品的逐漸成熟，其保密程度會逐漸放開，所以每份文檔的

密級標志是動態(tài)的。納入基線后的文檔密級若需要改變，可由項目經(jīng)理提出申請，配置管理

工程師責對文檔所在配置庫重新分配權(quán)限。

文檔密級共分為四級：

>絕密指只有極少數(shù)人可以直閱的文檔。如：核心技術(shù)的文檔、預(yù)研項目的文檔等。

此類文檔應(yīng)嚴格，呆需，配智庫權(quán)限一船只分配給研發(fā)領(lǐng)導指定人員，須簽訂保密協(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)容

定義一個唯一的編號。文檔編號由PPQA分配。

注：硬件原理圖、PCB圖、結(jié)構(gòu)圖紙、BOM等文件編碼不在此編號范圍內(nèi)。

7.1文檔編號規(guī)則

文檔編號由五部分組成，各部分由分隔，其構(gòu)成如下：

產(chǎn)品型號一項目編號一階段代號一模塊代號

對文檔進行編號時，各組成部分最好都有對應(yīng)的代號及含義。如果不需區(qū)分模塊，則以

代替模塊代號。

其中：

>產(chǎn)品型號：一般對應(yīng)于產(chǎn)品型號（外部型號x

>項目編號：所開發(fā)產(chǎn)品的項目編號。

>階段代號：此文檔對應(yīng)的項目階段代號，請參見7.2。

>模塊代號：軟件功能模塊或硬件單板的縮寫。

如：項目設(shè)計階段的設(shè)計文檔《MPE模塊概要設(shè)計書》的文檔標號為：CDVB5U0G_

DC-P071114-21_PD.SW_MPEo

7.2階段代號

階段代號由2~4位英文字母和T立”字符表示，構(gòu)成如下：

主階段代號.子階段代號

1~2位1~2位

例如「可行性研究報告”文檔對應(yīng)的階段編號為LR,"系統(tǒng)測試計劃”文檔對應(yīng)的階

段代號為SA.TP。

文檔各階段代號如表2所示。

文檔階段代號

項目階段文檔名稱主階段代號子階段代號

可行性研究報告I(Initialization)F(Feasibility)

立項產(chǎn)品規(guī)格說明書I(Initialization)S(Specification)

立項報告I(Initialization)R(Report)

系統(tǒng)需求規(guī)格說明書R(Requirement)S(System)

軟件需求規(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(QualityAssurance)

P(Planning)CM(Configuration

配置管理計劃

Management)

進度計劃P(Planning)S(Schedule)

軟件概要設(shè)計說明書PD(PreliminarySW(Software)

Design)

硬件概要設(shè)計說明書PD(PreliminaryHW(Hardware)

設(shè)計

Design)

結(jié)構(gòu)概要設(shè)計說明書PD(PreliminaryST(Structure)

Design)

軟件詳細設(shè)計說明書IM(Implementation)SW(Software)

單元測試計劃書IM(Implementation)UP(UnitTestingPlan)

單元測試用例IM(Implementation)UC(UnitTestingCase)

單元測試報告IM(Implementation)UR(UnitTestingReport)

實現(xiàn)

產(chǎn)品集成計劃IM(Implementation)IP(IntegrationPlan；

集成測試計劃書IM(Implementation)TP(TestingPlan)

接口說明書IM(Implementation)I(Interface)

集成測試用例IM(Implementation)TC(TestingCase)

集成測試報告IM(Implementation)TR(Testing