1、最新修正版*公司 技術(shù)研發(fā)中心32一、目的:(1)規(guī)范公司內(nèi)部技術(shù)研發(fā)工作的文檔管理;(2)保持技術(shù)研發(fā)工作的完整性與連續(xù)性;(3)防止技術(shù)流失，減少風險;(4)使技術(shù)文檔成為技術(shù)研發(fā)工作中的重要組成部分。第一部分總綱二、適用范圍：本公司內(nèi)部一切與技術(shù)研發(fā)有關(guān)的部門及個人，包括三、目標:通過切實可行的文檔管理規(guī)范，使得研發(fā)工作透明，明確，有章可循，合作無障礙，銜接環(huán)節(jié)暢通；使得所有的研發(fā)產(chǎn)品從開始研發(fā) 研發(fā)進程 測試 修改 階段性結(jié)束 產(chǎn)品轉(zhuǎn)化 升級維護過程中的所有環(huán)節(jié)都得以在相應(yīng)的文檔中體現(xiàn)。四、版 本：E2003V0.10 (簡稱 V0.10 )五、制定原則:(1)實用：鑒于公司目前的狀況

2、，通用性的開發(fā)模板(如國標)在很大程度上對于本公司并不實用，所以本規(guī)范將不會完全照搬此類模板，而是根據(jù)公司的具體情況制定公司內(nèi)部的標準;(2)可行：可行性是該標準的起碼要求，沒有可行性的標準不能成為真正的“標準”(3)高效：如果將國標中的所有規(guī)范內(nèi)容都納入本標準，一定可以達到目的，實現(xiàn)目標。但是，同時必將為相關(guān)人員增添大量的工作量，而且很多工作對于本公司來說是冗余，從而造成相關(guān)人員的抵觸情緒，使標準難于貫徹。所以，本標準應(yīng)力求在盡量少的模板中體現(xiàn)盡量多的內(nèi)容;(4)科學(xué)：本標準的制定雖然不完全照搬其他通用性的標準，但將大量參照通用標準，特別是國標中的某些部分內(nèi)容，不是拋棄國標，而是以國標為原則

3、，以保證科學(xué)性;(5)建立在廣泛意見基礎(chǔ)上： 本標準并非公司某一個人單方面的意愿，而是從公司利益出發(fā)， 全體相關(guān)人員共同參與， 集體的結(jié)晶。六、實行過程及生效日期:(1)V0.10版的規(guī)范為規(guī)范草稿，草稿制訂完成后，將在相關(guān)部門和相關(guān)人員中進行傳閱和廣泛征求意見。經(jīng)過三次全體相關(guān)人員參與討論和修改，由總經(jīng)理審批簽字后的規(guī)范版本為0.40。(1)總經(jīng)理；(2)技術(shù)部門經(jīng)理或負責人;(3)研發(fā)工程師；(4)測試工程師；(5)技術(shù)支持工程師。(2)V0.40為試用版本，在 V0.40的試用過程中，將要求并給予相關(guān)人員以合理的時間盡量按照V0.40版的要求規(guī)范修改，補充和完善V0.40版以前(包括V0

4、.10以前欠缺的文檔)的有價值文檔。在此期間，如有新的研發(fā)工作開始啟動，將要求相關(guān)人員按照V0.40版的規(guī)范要求進行文檔的相關(guān)操作。在此過程中，如果發(fā)現(xiàn)規(guī)范中需要修改和補充之處，每經(jīng)過一次大幅度的修改,版本即升級到 V0.5i (i=1,2,3,n,)，每經(jīng)過一次小的修改或補充，版本將升級為V0.4j (j=1,2,3,n)。(3)V1.00為正式版本。此時的版本已經(jīng)經(jīng)過討論，試用，修改，補充和不斷完善，并且V1.00以前欠缺的文檔與 V0.40試用過程中的文檔都已經(jīng)按照 V0.40版本的要求整理完畢，此時的V0.40版已經(jīng)成熟，可以整體升級到V1.00版。V1.00版本的文檔規(guī)并且將文檔的撰

5、寫工作作為技術(shù)研范將作為公司內(nèi)部與技術(shù)研發(fā)工作相關(guān)的所有人員在今后相當一段時間內(nèi)共同遵守的規(guī)范,發(fā)的一個重要組成部分正式納入到技術(shù)研發(fā)工作中。(4)V1.00規(guī)范將具有強制性和高約束力。(注:Vi.00，i=0,1,2,表示i版本系列；Vi.mn，i，m，n=0，1，2，表示i版本系列下的改動或升級)第二部分目錄索引、版本控制規(guī)則二、立項1、說明 2、模板三、需求分析1、說明 2、模板四、可行性分析1、說明 2、模板五、功能定義1、說明 2.模板六、概要設(shè)計1、硬件部分(1) 說明(2) 模板2、軟件部分(1) 說明(2) 模板 七、詳細設(shè)計1、硬件部分(1) 說明(2) 模板2、軟件部分(1

6、) 說明(2) 模板 八、測試1、測試流程 2、測試要求(1)硬件部分(2)軟件部分3、測試模板(1)硬件部分(2)軟件部分 九、從研發(fā)到產(chǎn)品的過渡(1) 要求(2) 模板 十、技術(shù)支持(1) 要求(2) 模板 十一、文檔工作的評估與審核(1)評估標準(2)審核要點第三部分內(nèi)容、版本控制規(guī)則(1)版本狀態(tài)：Beta/測試版，Release正式版，Changing/變更(2)版本號：版本號以三位數(shù)字表示，格式為i.jk （i=0，1，2，n; jk=01，99）a.Beta 版，i=0b.第一次正式發(fā)布的 Release版，1.00C.用Changing來表示Beta或Release版本的修改或

7、升級d.小的改動或升級i ,畀呆持不變，只增加k值即可，k的升值幅度為修改或升級處的數(shù)目當k值達到或增加至9時，j=j+1，e.k=0比較大的改動如,一次修改或升級處的數(shù)目>10，功能性的增加或改變，則i保持不變，增加j值。如果是功能性的修改或變動，每有一項j+1 ;如果是>10的非功能性的修改，每10處修改，j+1，個數(shù)部分用k來表示f.重大變動，i值增加g.累計功能變動超過百次,i+1，jk=00二、立項立項管理（Project Initialization Management, PIM）的目的是采納符合公司最大利益的立項建議，通過立項管理使該建議成為正式的項目（合法化）。杜

8、絕不符合公司最大利益的立項建議被采納，避免公司人力資源的，資金，時間的浪費。立項管理是決策行為，目標是“做正確的事情” （do right things）。而立項之后的研發(fā)管理活動是保證項目團隊“正確地做事情” （do things right）。“正確的決策” + “正確地執(zhí)行”才有可能產(chǎn)生好的產(chǎn)品。1、說明:(1)(2)立項：任何一次研發(fā)工作的啟動，包括全新的項目和在以往的項目基礎(chǔ)上進行升級或改版的項目，都需要進行立項的工作。項目分級：為了明晰立項的工作，使之有條理，可操作，所以將項目區(qū)分為一級項目和二級項目兩個不同的等級a、一級項目：包括全新的項目的啟動，原有項目的重大改版和升級b、二級

9、項目：在以往項目的基礎(chǔ)上進行的非重大的版本修改和完善(3)項目審批:所有一級項目必須由項目負責人提交項目申請計劃書,并就項目的相關(guān)情況向總經(jīng)理和技術(shù)總監(jiān)書面陳述或面對面溝通,得到總經(jīng)理和技術(shù)總監(jiān)的審批簽字后方能啟動;一級項目必須附加需求分析與可行性分析 二級項目可以由部門經(jīng)理指定或由項目負責人申請得到部門經(jīng)理審批簽字后即可執(zhí)行，不必交由總經(jīng)理和技術(shù)總監(jiān)審批簽字;d、對于二級項目，必須將項目計劃申請書（紙介質(zhì)）交由技術(shù)文檔負責人歸檔，總經(jīng)理及技術(shù)總監(jiān)對二級項目的進展情況具有知情權(quán)，而項目負責人具有向總經(jīng)理和技術(shù)總監(jiān)匯報（主動或被動）項目相關(guān)情況的義務(wù);e、項目申請計劃書一式兩份：紙介質(zhì)文檔與電子

10、文檔。紙介質(zhì)文檔作為技術(shù)檔案由專門負責人員備份歸檔。電子文檔按規(guī)范要求存儲在公司指定的文檔服務(wù)器上。(4)權(quán)利，責任與義務(wù)總經(jīng)理，技術(shù)總監(jiān)，部門經(jīng)理對其所具有審批權(quán)限的項目申請計劃書具有否決的權(quán)利;項目申請人有權(quán)要求否決人說明被否決的理由，而且否決人必須在被否決的項目申請計劃書中陳述否決理由;具有審批權(quán)限的人對于項目的合理性，需求性，可行性等判斷負有全權(quán)責任;2、項目申請計劃書項目申請計劃書/立項建議書（年月日-年月日（年月日-年月日）（年月日-年月日）項目編號EPF2003NOX-01級另y級項目二級項目類另y指定項目申請項目版本說明V0.10申請人Su申請日期2003-8-18負責人Su組

11、成員Su,Zha ng,Yu項目名稱基于GPRS的圖像傳輸產(chǎn)品名稱G-BIU ( Hardware , GPRS-Based Image Unit),G-BIUST(Software , G-BIU Support Toolkit)理由陳述資源配置需求成本簡要核算（暫時可不添此項）期期近遠中 長 期（在此陳述進行該項目可能遇到和需要解決的問題，除了技術(shù)層面外，還包括設(shè)備,人員配備等方方面面的主要問題）問題與解決解決方法針對以上的問題，提出解決建議備注說明通過審批結(jié)果審批人簽字審批意見否決審批日期三、需求分析:如果說立項管理是為了解決do right things和do things right

12、的問題，那么需求分析就是要解決do what things的問題。需求產(chǎn)生目標,目標引領(lǐng)方向。好的需求分析不僅要解決“需要做什么”，同時明確“什么不需要做”。最好的，可能產(chǎn)生最大利益的產(chǎn)品是“恰如其分” 的產(chǎn)品。所謂“恰如其分”就是：產(chǎn)品的功能恰好滿足那些特定的需求，產(chǎn)品功能不多也不少。一般的情況下，總結(jié)出“需好做什么” 比區(qū)分“什么不需要做”要來的容易，但“什么不需要做”的界定往往會影響到成本投入和利益產(chǎn)出的比例。1、說明:(1)(2)需求分析工作的安排：進行一項產(chǎn)品的開發(fā)工作的一般流程應(yīng)該是：市場調(diào)查一需求分析一可行性研究一立項審核一概要設(shè)計（總體設(shè)計）一詳細設(shè)計一單元測試一集成測試一修改

13、完善一項目評估，審核一批量生產(chǎn)一投放市場一技術(shù)支持與售后服務(wù)。需求的種類：需求的本質(zhì)上都來源于市場，但是在具體表現(xiàn)上又有所不同。有的需求直接由用戶提出，目標明確；而有些需求則是我們從市場的零星反饋中總結(jié)出來的，帶有預(yù)見性和自主性。(3)需求分析的主要目的：從市場的反饋或?qū)κ袌龅挠^察與預(yù)見中總結(jié)出市場的需求,并用理性的思維對這些需求進行分析和總結(jié),(4)(5)將需求明確，為后面的工作奠定基礎(chǔ)。需求分析的作用：需求分析是市場與技術(shù)的轉(zhuǎn)換點。經(jīng)過需求分析后，工作的重心即由市場轉(zhuǎn)移到技術(shù)，明確的需求分析是真正進行研發(fā)工作的起點，是進行產(chǎn)品開發(fā)一系列后序工作的基礎(chǔ)。需求在進行研發(fā)的過程中如果發(fā)生變更，需

14、要填寫“需求變更說明書”2、模板1配置編號目標用戶需求陳述解決方法附加說明討論意見項目評審委員會結(jié)論A需求:B需求:C需求:需求分析說明書/報告EPF2003NOX-02作者提交時間2003-8-18陳述產(chǎn)品的目標用戶內(nèi)容級別1 A B C2簡單描述針對需求的初步解決意向緊急，重要重要，不緊急非A,B類需求模板2需求/功能變更說明書配置編號EPF2003NOX-02-01歷史版本V2.00改后版本V2.17產(chǎn)品名稱G-BIU(GPRS-Based Image Unit)負責人時間2003-8-19變更項變更內(nèi)容變更屬性變更原因是否允許1 A D M是 否23附加說明變更屬性中A代表增加，D代表

15、刪除，M代表修改項目評審委員會結(jié)論項目評審委員會給出是否進行變更的意見，由評委會主席簽字生效四、技術(shù)可行性分析可行性分析是進行研發(fā)工作的重要環(huán)節(jié)，詳細周到的可行性分析與論證為即將啟動的項目把握一道至關(guān)重要的關(guān)口。可行性分析報告由項目申請責任人技術(shù)可行性分析要求從技術(shù)層面上分析論證項目的可行性，即能否“做得到，做得快，做得好” 總結(jié)，撰寫，并提交到項目評審委員會審閱。有項目申請/建議書，需求定義和需求報告仍然不能進行實質(zhì)性的開發(fā)，必須要進行可行性分析，可行性分析包括幾個部分(1)市場分析:a.分析總結(jié)市場的發(fā)展趨勢，說明產(chǎn)品處于市場的什么發(fā)展階段，粗略估計產(chǎn)品的生命周期b.本產(chǎn)品和同類產(chǎn)品的價格

16、比對C.d.(2)政策分析a.分析有無相關(guān)政策“支持”或“限制”b.分析有無地方政府或其他機構(gòu)的“扶持”或“干擾”(3)競爭分析a.分析競爭對手的市場狀況，產(chǎn)品的優(yōu)點與缺點b.預(yù)測可能形成的競爭的特點與周期(4)技術(shù)可行性分析(5)時間和資源可行性分析統(tǒng)計產(chǎn)品當前市場總額，競爭對手所占的份額，分析本產(chǎn)品有哪些比較優(yōu)勢，可能占有多少市場份額為產(chǎn)品定位，即確定產(chǎn)品用戶群，分析產(chǎn)品消費群體特征，消費方式及影像市場的因素分析a.按正常的運作，從產(chǎn)品開發(fā)到投入市場，時間上是否來得及b.計劃中的人員能否及時到位C.計劃中的軟硬件需求能否及時到位d.成本核算能否負擔得起(6)知識產(chǎn)權(quán)分析a.是否已經(jīng)存在某些

17、專利將妨礙本產(chǎn)品的開發(fā)與推廣b.產(chǎn)品能否得到知識產(chǎn)權(quán)的保護配置編號EPF2003NOX-03技術(shù)可行性分析報告報告撰寫人提交時間2003-8-19由項目負責人總結(jié)，撰寫可行性論述主要從能否“做得到”，“做得快”，“做得好”的角度分析 如果能“做得到”，“做得快”，“做得好”，需要給出通過怎樣的方法保證 如果不能，需要給出理由由技術(shù)秘書總結(jié)討論意見撰寫人提交報告后到項目評審委員會后，項目評審委員組織人員對報告的“可行性論述”展開討論，技術(shù)秘書總結(jié) 各方意見，記述在此欄項目評審委項目評審委員會給出整體意見，供決策人參考員會意見五、功能定義1.說明：功能定義是對 do what things的明確界

18、定，是針對明確的需求來定義產(chǎn)品功能的過程。是產(chǎn)品設(shè)計的實質(zhì)性階段，此后的研發(fā)工作將圍繞功能定義展開，功能定義說明書是參與研發(fā)的人員進行工作的基礎(chǔ)文檔，是產(chǎn)品測試與評審，用戶手冊的編制，市場宣傳的主要依據(jù)。2.模版功能定義說明書六、概要設(shè)計1、硬件部分：為了簡化操作流程，使文檔既能體現(xiàn)設(shè)計原理與設(shè)計思路，又具有良好的操作性，所以對于硬件部分的概要設(shè)計要求只 要求給出原理圖，思路描述，主要器件，主要器件的技術(shù)參數(shù)。概要設(shè)計報告（H）2、軟件部分：軟件部分的概要設(shè)計需要提交的報告有：概要設(shè)計報告，界面設(shè)計報告，數(shù)據(jù)庫設(shè)計報告概要設(shè)計報告（S）*如果系統(tǒng)比較復(fù)雜，首先將系統(tǒng)分解成若干子系統(tǒng)，對各個子系

19、統(tǒng)繪制邏輯圖，說明子系統(tǒng)的功能*解釋如何以及為什么如此分解系統(tǒng)*說明子系統(tǒng)間如何如何協(xié)調(diào)工作，以實現(xiàn)元系統(tǒng)的功能*如果子系統(tǒng)N仍然需要分解成模塊，則(1)繪制模塊邏輯圖(2)陳述分解理由(3)說明模塊間如何協(xié)調(diào)工作，從而實現(xiàn)子系統(tǒng)的功能*如果系統(tǒng)相對簡單，給出用工具 Visio繪制的系統(tǒng)邏輯結(jié)構(gòu)圖界面設(shè)計報告界面設(shè)計報告(S)配置編號EPF2003NOX-05-S-02作者時間2003-8-19當前版本V1.20歷史版本V1.00，V1.07，V1.17界面結(jié)構(gòu)及風格繪制界面視圖(1) 主界面：需要給出界面元素的作用與操作(2) 子界面：給出子界面的主要作用第三方界面元素 控件，組件，函數(shù) 庫

20、及其來源名稱來源作用12數(shù)據(jù)庫設(shè)計報告主要完成數(shù)據(jù)庫的物理設(shè)計，即表的結(jié)構(gòu)設(shè)計與對表結(jié)構(gòu)的第三范式處理數(shù)據(jù)庫設(shè)計報告（S）配置編號EPF2003NOX-05-S-03作者時間2003-8-19當前版本V1.20歷史版本V1.00，V1.07，V1.17表匯總表名功能描述1A2B3CA列名數(shù)據(jù)類型（經(jīng)度范圍）約束條件備注12補充說明角色與權(quán)限可以訪問的表與列訪問權(quán)限角色A角色B七、詳細設(shè)計1.硬件部分，硬件部分的詳細設(shè)計主要體現(xiàn)在下位機軟件的代碼上，所以詳細設(shè)計文檔的內(nèi)容集中在對代碼的要求上面，代碼要求(1)所有的代碼模塊必須用文件的方式組織(2)在每一個文件中的開頭以注釋的方式寫如下內(nèi)容:Co

21、pyright( c) 2003，*公司，硬件開發(fā)部 *AII rights reserved *文件名稱: *文件標識：文件標識可以統(tǒng)一規(guī)定，也可以自己選擇*摘要：簡要描述該文件的內(nèi)容*當前版本:*作者：輸入作者或修改者的名字*完成日期:*取代版本: *原作者*完成日期:(3)如果用C語言開發(fā)a.必須將.H文件與.C文件區(qū)分開來，在.H中定義全局變量，結(jié)構(gòu)，聯(lián)合，自定義群體等，如鏈表；函數(shù)的聲明b.在定義函數(shù)體前，以注釋方式寫如下內(nèi)容*函數(shù)的主要作用*輸入輸出參數(shù)的含義(4)全局變量的定義要集中，并說明用途(5)主要變量必須在定義之后說明用途(6)所有函數(shù)的定義必須給出函數(shù)的作用詳細設(shè)計報告

22、（H）配置編號EPF2003NOX-06-H作者時間2003-8-20當前版本歷史版本所有函數(shù)定義列表函數(shù)定義主要用途外部接口12流程圖外部接口 /庫接口 /庫名主要用途來源12通訊協(xié)議內(nèi)部通訊協(xié)議外部協(xié)議1填入內(nèi)部通訊協(xié)議文檔配置編號女口 SMPP , S7 等2其他說明2.軟件部分軟件部分的詳細設(shè)計報告內(nèi)容相對較多，所以設(shè)計報告分成若干部分詳細設(shè)計報告（SP1）配置編號EPF2003NOX-06-S-01作者時間2003-8-20當前版本歷史版本系統(tǒng)架構(gòu)如果能用圖表示，必須用圖表示，不好用圖表示的部分，可以用文字描述主要控件/組件名稱作用來源使用12類/結(jié)構(gòu)類名作用12主要的數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)

23、構(gòu)描述12關(guān)鍵算法算法作用實現(xiàn)過程12自定義消息消息名稱消息IDInvoke條件12其他說明主要控件一欄包括:Share等；必須簡要描述第三方控件，如 MapX，F(xiàn)latstyle等，在使用此類控件中必須給出此控件的作用，來源如購買,此類控件的使用方法，如果控件本身帶有資料描述，必須以附錄資料的形式給出資料 主要的類/結(jié)構(gòu)：程序中所有用到的類，包括自己獨立封裝的類，從固有的類中集成下來的類，簡要陳述類的作用。如果 回使用建模工具，則需要用類圖來描述出類的結(jié)構(gòu)，繼承關(guān)系等。主要的數(shù)據(jù)結(jié)構(gòu)，如結(jié)構(gòu)（記錄），鏈表，棧，隊列，圖，樹及作用 關(guān)鍵算法：關(guān)鍵不是復(fù)雜，任何一個程序都有關(guān)鍵算法，這里的“關(guān)鍵

24、”的引申含義為：主要，重要。必須給出算法的 作用與實現(xiàn)的思路過程描述MapX控件時，需要詳細設(shè)計報告（SP2）配置編號EPF2003NOX-06-S-02作者時間2003-8-20當前版本歷史版本外部接口接口作用參數(shù)描述1Map .Distance。23內(nèi)部接口（方法/函數(shù)/過程）接口作用宿主參數(shù)描述123其他說明所謂接口，不過是函數(shù)在特定概念下的稱謂。夕卜部接口，程序中所使用的外部函數(shù)。例如，在使用使用Ma p.Distance（）接口函數(shù)來計算距離，那么既需要描述出Map .Distance。的作用與參數(shù)描述內(nèi)部接口：所謂宿主，即指包括此接口的自定義或從固有類繼承而來的類，如果是全局函數(shù)，

25、宿主欄填寫詳細設(shè)計報告（SP3）配置編號EPF2003NOX-06-S-03作者時間2003-8-20當前版本歷史版本流程圖配置編號1EPF2003NOX-06-S-03-CF-012其他說明流程圖主要描述程序的關(guān)鍵流程，對關(guān)鍵的判斷依據(jù)是：如果沒有此流程圖描述，則對他人理解此程序存有障礙SP3）的附件由于流程圖一般占用較大空間，所以將其作為詳細設(shè)計報告（八、測試bug,還可以發(fā)1/41/3。測試是產(chǎn)品研發(fā)中相當重要的部分，在IT領(lǐng)域越來越受到人們的普遍重視。高水平的測試不僅可以發(fā)現(xiàn)表面存在的現(xiàn)產(chǎn)品內(nèi)部設(shè)計缺陷，消除潛在隱患，提出修改完善建議等。測試，在產(chǎn)品研發(fā)中所占用的時間比例大約是整個研發(fā)

26、周期的但是，鑒于公司的實際情況，需要制定有效的，符合公司使用要求，實用的測試規(guī)程。產(chǎn)品測試規(guī)定為兩個部分(1)內(nèi)部測試:(2)產(chǎn)品測試:計報告(3)集成測試:及產(chǎn)品的各個功能部分一起運作下的測試即指開發(fā)人員自己進行的測試工作，基本要求是在一般情況下，產(chǎn)品能夠正常啟動運行即可當內(nèi)部測試完成以后，測試人員進行產(chǎn)品測試，測試的依據(jù)為項目建議書，概要設(shè)計報告，功能定義報告，詳細設(shè)產(chǎn)品測試在目前看來，最主要的是要測試產(chǎn)品的功能，測試功能的主要依據(jù)則是功能定義報告。在產(chǎn)品測試前，開發(fā)人員必須提供一套測試樣本。產(chǎn)品測試報告（HP1）配置編號EPF2003NOX-07-H-01測試人負責人測試時間2003-8

27、-21產(chǎn)品名稱版本歷史版本測試環(huán)境及工具測試項功能是否通過備注1 Yes No2遺留問題問題描述問題級別原因分析1 R Y O2測試結(jié)論測試人簽字手寫問題級別:(1)R：即Red，紅色級別，重大問題，關(guān)鍵問題，如執(zhí)行某項功能時，導(dǎo)致系統(tǒng)死機（死循環(huán)），崩潰等(2)(3)Y:即Yellow，黃色級別，功能性問題，某項功能無法通過O:即Orange,橙色級別，功能可以實現(xiàn)，但操作十分不便產(chǎn)品測試報告（HP2）配置編號EPF2003NOX-07-H-02測試人負責人測試時間2003-8-21產(chǎn)品版本歷史版本測試環(huán)境及工具問題項功能問題原因是否解決是否通過i Yes No Yes Nom遺留問題問題描述問題級別原因分析