技術(shù)研發(fā)文檔模版0.0

1、第一部分總綱一目的：（ 1） 規(guī)范公司內(nèi)部技術(shù)研發(fā)工作的文檔管理；（ 2） 保持技術(shù)研發(fā)工作的完整性與連續(xù)性；（ 3） 防止技術(shù)流失，減少風(fēng)險(xiǎn)；（ 4） 使技術(shù)文檔成為技術(shù)研發(fā)工作中的重要組成部分。二適用范圍：本公司內(nèi)部一切與技術(shù)研發(fā)有關(guān)的部門及個(gè)人，包括（ 1） 總經(jīng)理；（ 2） 技術(shù)部門經(jīng)理或負(fù)責(zé)人；（ 3） 研發(fā)工程師；（ 4） 測(cè)試工程師；（ 5） 技術(shù)支持工程師。三目標(biāo)：通過切實(shí)可行的文檔管理規(guī)范，使得研發(fā)工作透明，明確，有章可循，合作無障礙，銜接環(huán)節(jié)暢通；使得所有的研發(fā)產(chǎn)品從開始研發(fā)研發(fā)進(jìn)程測(cè)試修改階段性結(jié)束產(chǎn)品轉(zhuǎn)化升級(jí)維護(hù)過程中的所有環(huán)節(jié)都得以在相應(yīng)的文檔中體現(xiàn)。四版本： E20

2、03V0.10（簡(jiǎn)稱 V0.10 ）。五制定原則：（ 1） 實(shí)用：鑒于公司目前的狀況，通用性的開發(fā)模板（如國(guó)標(biāo)）在很大程度上對(duì)于本公司并不實(shí)用，所以本規(guī)范將不會(huì)完全照搬此類模板，而是根據(jù)公司的具體情況制定公司內(nèi)部的標(biāo)準(zhǔn)；（ 2） 可行：可行性是該標(biāo)準(zhǔn)的起碼要求，沒有可行性的標(biāo)準(zhǔn)不能成為真正的“標(biāo)準(zhǔn)”；（ 3） 高效：如果將國(guó)標(biāo)中的所有規(guī)范內(nèi)容都納入本標(biāo)準(zhǔn)，一定可以達(dá)到目的，實(shí)現(xiàn)目標(biāo)。但是，同時(shí)必將為相關(guān)人員增添大量的工作量，而且很多工作對(duì)于本公司來說是冗余，從而造成相關(guān)人員的抵觸情緒，使標(biāo)準(zhǔn)難于貫徹。所以，本標(biāo)準(zhǔn)應(yīng)力求在盡量少的模板中體現(xiàn)盡量多的內(nèi)容；（ 4） 科學(xué)：本標(biāo)準(zhǔn)的制定雖然不完全照搬

3、其他通用性的標(biāo)準(zhǔn)，但將大量參照通用標(biāo)準(zhǔn)，特別是國(guó)標(biāo)中的某些部分內(nèi)容，不是拋棄國(guó)標(biāo)，而是以國(guó)標(biāo)為原則，以保證科學(xué)性；（ 5） 建立在廣泛意見基礎(chǔ)上： 本標(biāo)準(zhǔn)并非公司某一個(gè)人單方面的意愿，而是從公司利益出發(fā)， 全體相關(guān)人員共同參與， 集體的結(jié)晶。六實(shí)行過程及生效日期：（ 1）V0.10 版的規(guī)范為規(guī)范草稿，草稿制訂完成后，將在相關(guān)部門和相關(guān)人員中進(jìn)行傳閱和廣泛征求意見。經(jīng)過三次全體相關(guān)人員參與討論和修改，由總經(jīng)理審批簽字后的規(guī)范版本為0.40 。（ 2）V0.40 為試用版本，在 V0.40 的試用過程中，將要求并給予相關(guān)人員以合理的時(shí)間盡量按照V0.40 版的要求規(guī)范修改，補(bǔ)充和完善 V0.40

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

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

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

7、的Release 版， 1.00c. 用 Changing 來表示 Beta 或 Release 版本的修改或升級(jí)d.小的改動(dòng)或升級(jí)i ，j保持不變， 只增加k 值即可， k的升值幅度為修改或升級(jí)處的數(shù)目，當(dāng) k值達(dá)到或增加至9 時(shí)，j=j+1，k=0e.比較大的改動(dòng)如，一次修改或升級(jí)處的數(shù)目>10，功能性的增加或改變，則i 保持不變，增加j 值。如果是功能性的修改或變動(dòng)，每有一項(xiàng)j+1 ；如果是>10 的非功能性的修改，每10 處修改，j+1 ，個(gè)數(shù)部分用k 來表示f. 重大變動(dòng)， i 值增加g. 累計(jì)功能變動(dòng)超過百次， i+1 ， jk=00二立項(xiàng)立項(xiàng)管理（Project In

8、itialization Management，PIM）的目的是采納符合公司最大利益的立項(xiàng)建議，通過立項(xiàng)管理使該建議成為正式的項(xiàng)目（合法化） 。杜絕不符合公司最大利益的立項(xiàng)建議被采納，避免公司人力資源的，資金，時(shí)間的浪費(fèi)。立項(xiàng)管理是決策行為，目標(biāo)是“做正確的事情”（do right things）。而立項(xiàng)之后的研發(fā)管理活動(dòng)是保證項(xiàng)目團(tuán)隊(duì)“正確地做事情”(dothings right)?！罢_的決策”+“正確地執(zhí)行”才有可能產(chǎn)生好的產(chǎn)品。1說明：（ 1） 立項(xiàng)：任何一次研發(fā)工作的啟動(dòng)，包括全新的項(xiàng)目和在以往的項(xiàng)目基礎(chǔ)上進(jìn)行升級(jí)或改版的項(xiàng)目，都需要進(jìn)行立項(xiàng)的工作。（ 2） 項(xiàng)目分級(jí)：為了明晰立項(xiàng)的

9、工作，使之有條理，可操作，所以將項(xiàng)目區(qū)分為一級(jí)項(xiàng)目和二級(jí)項(xiàng)目?jī)蓚€(gè)不同的等級(jí)a一級(jí)項(xiàng)目：包括全新的項(xiàng)目的啟動(dòng)，原有項(xiàng)目的重大改版和升級(jí)b二級(jí)項(xiàng)目：在以往項(xiàng)目的基礎(chǔ)上進(jìn)行的非重大的版本修改和完善（ 3）項(xiàng)目審批：a 所有一級(jí)項(xiàng)目必須由項(xiàng)目負(fù)責(zé)人提交項(xiàng)目申請(qǐng)計(jì)劃書，并就項(xiàng)目的相關(guān)情況向總經(jīng)理和技術(shù)總監(jiān)書面陳述或面對(duì)面溝通，得到總經(jīng)理和技術(shù)總監(jiān)的審批簽字后方能啟動(dòng)；b 一級(jí)項(xiàng)目必須附加需求分析與可行性分析c 二級(jí)項(xiàng)目可以由部門經(jīng)理指定或由項(xiàng)目負(fù)責(zé)人申請(qǐng)得到部門經(jīng)理審批簽字后即可執(zhí)行，不必交由總經(jīng)理和技術(shù)總監(jiān)審批簽字；d對(duì)于二級(jí)項(xiàng)目，必須將項(xiàng)目計(jì)劃申請(qǐng)書（紙介質(zhì)）交由技術(shù)文檔負(fù)責(zé)人歸檔，總經(jīng)理及技術(shù)總監(jiān)

10、對(duì)二級(jí)項(xiàng)目的進(jìn)展情況具有知情權(quán)，而項(xiàng)目負(fù)責(zé)人具有向總經(jīng)理和技術(shù)總監(jiān)匯報(bào)（主動(dòng)或被動(dòng)）項(xiàng)目相關(guān)情況的義務(wù)；e項(xiàng)目申請(qǐng)計(jì)劃書一式兩份：紙介質(zhì)文檔與電子文檔。紙介質(zhì)文檔作為技術(shù)檔案由專門負(fù)責(zé)人員備份歸檔。電子文檔按規(guī)范要求存儲(chǔ)在公司指定的文檔服務(wù)器上。（ 4）權(quán)利，責(zé)任與義務(wù)a 總經(jīng)理，技術(shù)總監(jiān)，部門經(jīng)理對(duì)其所具有審批權(quán)限的項(xiàng)目申請(qǐng)計(jì)劃書具有否決的權(quán)利；b 項(xiàng)目申請(qǐng)人有權(quán)要求否決人說明被否決的理由，而且否決人必須在被否決的項(xiàng)目申請(qǐng)計(jì)劃書中陳述否決理由； c 具有審批權(quán)限的人對(duì)于項(xiàng)目的合理性，需求性，可行性等判斷負(fù)有全權(quán)責(zé)任；2項(xiàng)目申請(qǐng)計(jì)劃書項(xiàng)目申請(qǐng)計(jì)劃書 / 立項(xiàng)建議書項(xiàng)目編號(hào)類別申 請(qǐng) 人負(fù)責(zé)人項(xiàng)

11、目名稱理由陳述目標(biāo)問題與解決EPF2003NOX-01級(jí)別二級(jí)項(xiàng)目 一級(jí)項(xiàng)目指定項(xiàng)目版本說明V0.10 申請(qǐng)項(xiàng)目Su申請(qǐng)日期2003-8-18Su組 成 員Su,Zhang,Yu基于 GPRS的圖像傳輸產(chǎn)品名稱G-BIU（ Hardware， GPRS-Based Image Unit ），G-BIUST(Software ， G-BIU Support Toolkit)資源配置需求成本簡(jiǎn)要核算（暫時(shí)可不添此項(xiàng)）近期中長(zhǎng)期遠(yuǎn)期（年月日 年月日）（年月日 年月日）（年月日 年月日）（在此陳述進(jìn)行該項(xiàng)目可能遇到和需要解決的問題，除了技術(shù)層面外，還包括設(shè)備，問題人員配備等方方面面的主要問題）解決方法

12、針對(duì)以上的問題，提出解決建議備注說明審批結(jié)果通過否決審批日期審批人簽字審批意見三需求分析：如果說立項(xiàng)管理是為了解決 do right things 和 do things right 的問題，那么需求分析就是要解決 do what things 的問題。需求產(chǎn)生目標(biāo)，目標(biāo)引領(lǐng)方向。好的需求分析不僅要解決“需要做什么” ，同時(shí)明確“什么不需要做” 。最好的，可能產(chǎn)生最大利益的產(chǎn)品是“恰如其分”的產(chǎn)品。所謂“恰如其分”就是：產(chǎn)品的功能恰好滿足那些特定的需求，產(chǎn)品功能不多也不少。一般的情況下，總結(jié)出“需好做什么”比區(qū)分“什么不需要做”要來的容易，但“什么不需要做”的界定往往會(huì)影響到成本投入和利益產(chǎn)出

13、的比例。1說明：（ 1） 需求分析工作的安排：進(jìn)行一項(xiàng)產(chǎn)品的開發(fā)工作的一般流程應(yīng)該是：市場(chǎng)調(diào)查需求分析可行性研究立項(xiàng)審核概要設(shè)計(jì)（總體設(shè)計(jì)）詳細(xì)設(shè)計(jì)單元測(cè)試集成測(cè)試修改完善項(xiàng)目評(píng)估，審核批量生產(chǎn)投放市場(chǎng)技術(shù)支持與售后服務(wù)。（ 2） 需求的種類：需求的本質(zhì)上都來源于市場(chǎng)，但是在具體表現(xiàn)上又有所不同。有的需求直接由用戶提出，目標(biāo)明確；而有些需求則是我們從市場(chǎng)的零星反饋中總結(jié)出來的，帶有預(yù)見性和自主性。（ 3）需求分析的主要目的： 從市場(chǎng)的反饋或?qū)κ袌?chǎng)的觀察與預(yù)見中總結(jié)出市場(chǎng)的需求，并用理性的思維對(duì)這些需求進(jìn)行分析和總結(jié)，將需求明確，為后面的工作奠定基礎(chǔ)。（ 4） 需求分析的作用：需求分析是市場(chǎng)與技

14、術(shù)的轉(zhuǎn)換點(diǎn)。經(jīng)過需求分析后，工作的重心即由市場(chǎng)轉(zhuǎn)移到技術(shù)，明確的需求分析是真正進(jìn)行研發(fā)工作的起點(diǎn)，是進(jìn)行產(chǎn)品開發(fā)一系列后序工作的基礎(chǔ)。（ 5） 需求在進(jìn)行研發(fā)的過程中如果發(fā)生變更，需要填寫“需求變更說明書”2模板 1需求分析說明書 / 報(bào)告配置編號(hào)EPF2003NOX-02作者提交時(shí)間2003-8-18目標(biāo)用戶陳述產(chǎn)品的目標(biāo)用戶內(nèi)容級(jí)別需求陳述解決方法附加說明討論意見項(xiàng)目評(píng)審委員會(huì)結(jié)論1ABC2簡(jiǎn)單描述針對(duì)需求的初步解決意向A 需求：緊急，重要B 需求：重要，不緊急C 需求：非 A,B 類需求模板 2配置編號(hào)EPF2003NOX-02-01產(chǎn)品名稱G-BIU(GPRS-Based Image

15、Unit)需求 / 功能變更說明書歷史版本V2.00改后版本V2.17負(fù)責(zé)人時(shí)間2003-8-19變更項(xiàng)變更內(nèi)容123變更屬性變更原因是否允許ADM是否附加說明項(xiàng)目評(píng)審委員會(huì)結(jié)論變更屬性中A 代表增加， D 代表刪除， M代表修改項(xiàng)目評(píng)審委員會(huì)給出是否進(jìn)行變更的意見，由評(píng)委會(huì)主席簽字生效四技術(shù)可行性分析可行性分析是進(jìn)行研發(fā)工作的重要環(huán)節(jié)，詳細(xì)周到的可行性分析與論證為即將啟動(dòng)的項(xiàng)目把握一道至關(guān)重要的關(guān)口。技術(shù)可行性分析要求從技術(shù)層面上分析論證項(xiàng)目的可行性，即能否“做得到，做得快，做得好” ?？尚行苑治鰣?bào)告由項(xiàng)目申請(qǐng)責(zé)任人總結(jié)，撰寫，并提交到項(xiàng)目評(píng)審委員會(huì)審閱。有項(xiàng)目申請(qǐng) / 建議書，需求定義和需

16、求報(bào)告仍然不能進(jìn)行實(shí)質(zhì)性的開發(fā)，必須要進(jìn)行可行性分析，可行性分析包括幾個(gè)部分（ 1） 市場(chǎng)分析：a. 分析總結(jié)市場(chǎng)的發(fā)展趨勢(shì)，說明產(chǎn)品處于市場(chǎng)的什么發(fā)展階段，粗略估計(jì)產(chǎn)品的生命周期b. 本產(chǎn)品和同類產(chǎn)品的價(jià)格比對(duì)c. 統(tǒng)計(jì)產(chǎn)品當(dāng)前市場(chǎng)總額，競(jìng)爭(zhēng)對(duì)手所占的份額，分析本產(chǎn)品有哪些比較優(yōu)勢(shì)，可能占有多少市場(chǎng)份額d. 為產(chǎn)品定位，即確定產(chǎn)品用戶群，分析產(chǎn)品消費(fèi)群體特征，消費(fèi)方式及影像市場(chǎng)的因素分析（ 2） 政策分析a. 分析有無相關(guān)政策“支持”或“限制”b. 分析有無地方政府或其他機(jī)構(gòu)的“扶持”或“干擾”（ 3） 競(jìng)爭(zhēng)分析a. 分析競(jìng)爭(zhēng)對(duì)手的市場(chǎng)狀況，產(chǎn)品的優(yōu)點(diǎn)與缺點(diǎn)b. 預(yù)測(cè)可能形成的競(jìng)爭(zhēng)的特點(diǎn)與周

17、期（ 4） 技術(shù)可行性分析（ 5） 時(shí)間和資源可行性分析a. 按正常的運(yùn)作，從產(chǎn)品開發(fā)到投入市場(chǎng)，時(shí)間上是否來得及b. 計(jì)劃中的人員能否及時(shí)到位c. 計(jì)劃中的軟硬件需求能否及時(shí)到位d. 成本核算能否負(fù)擔(dān)得起（ 6） 知識(shí)產(chǎn)權(quán)分析a. 是否已經(jīng)存在某些專利將妨礙本產(chǎn)品的開發(fā)與推廣b. 產(chǎn)品能否得到知識(shí)產(chǎn)權(quán)的保護(hù)技術(shù)可行性分析報(bào)告配置編號(hào)EPF2003NOX-03報(bào)告撰寫人提交時(shí)間2003-8-19由項(xiàng)目負(fù)責(zé)人總結(jié)，撰寫主要從能否“做得到” ，“做得快”，“做得好”的角度分析可行性論述如果能“做得到” ，“做得快”，“做得好”，需要給出通過怎樣的方法保證如果不能，需要給出理由由技術(shù)秘書總結(jié)討論意見

18、撰寫人提交報(bào)告后到項(xiàng)目評(píng)審委員會(huì)后，項(xiàng)目評(píng)審委員組織人員對(duì)報(bào)告的“可行性論述”展開討論，技術(shù)秘書總結(jié)各方意見，記述在此欄項(xiàng)目評(píng)審委項(xiàng)目評(píng)審委員會(huì)給出整體意見，供決策人參考員會(huì)意見五功能定義1.說明：功能定義是對(duì)do what things的明確界定，是針對(duì)明確的需求來定義產(chǎn)品功能的過程。是產(chǎn)品設(shè)計(jì)的實(shí)質(zhì)性階段，此后的研發(fā)工作將圍繞功能定義展開，功能定義說明書是參與研發(fā)的人員進(jìn)行工作的基礎(chǔ)文檔，是產(chǎn)品測(cè)試與評(píng)審，用戶手冊(cè)的編制，市場(chǎng)宣傳的主要依據(jù)。2. 模版功能定義說明書配置編號(hào)EPF2003NOX-04負(fù)責(zé)人提交時(shí)間2003-8-19功能描述1功能項(xiàng)23附加說明項(xiàng)目評(píng)審委項(xiàng)目評(píng)審委員會(huì)給出整體

19、意見，供決策人參考員會(huì)意見六概要設(shè)計(jì)1、硬件部分：為了簡(jiǎn)化操作流程，使文檔既能體現(xiàn)設(shè)計(jì)原理與設(shè)計(jì)思路，又具有良好的操作性，所以對(duì)于硬件部分的概要設(shè)計(jì)要求只要求給出原理圖，思路描述，主要器件，主要器件的技術(shù)參數(shù)。概要設(shè)計(jì)報(bào)告（ H）配置編號(hào)EPF2003NOX-05-H負(fù)責(zé)人時(shí)間2003-8-19在此添入原理圖配置編號(hào)，原理圖配置編號(hào)由技術(shù)文檔秘書統(tǒng)一編制，編號(hào)編制方法待討論，原理圖（改動(dòng)： EPF2003NOX-05-H-01）設(shè)計(jì)思路描述基本要求：負(fù)責(zé)人必須對(duì)關(guān)鍵的設(shè)計(jì)思想進(jìn)行清楚的描述器件名稱用途技術(shù)參數(shù)參考主要器件1及技術(shù)參數(shù)23資料名稱來源編號(hào)主要參考資料12按照重要，關(guān)鍵性器件>

20、;主要器件 >輔助性器件的順序描述主要器件及技術(shù)參數(shù)欄。每一種參考資料都有自己的編號(hào)如：EPF2003NOX-05-H-R12、軟件部分 : 軟件部分的概要設(shè)計(jì)需要提交的報(bào)告有：概要設(shè)計(jì)報(bào)告，界面設(shè)計(jì)報(bào)告，數(shù)據(jù)庫設(shè)計(jì)報(bào)告概要設(shè)計(jì)報(bào)告（ S）配置編號(hào)當(dāng)前版本術(shù)語與縮寫解釋設(shè)計(jì)約束設(shè)計(jì)策略系統(tǒng)總體結(jié)構(gòu)描述開發(fā)環(huán)境配置運(yùn)行環(huán)境要求參考資料EPF2003NOX-05-S-01作者提交時(shí)間2003-8-19V1.20歷史版本V1.00 ，V1.07 ， V1.17術(shù)語解釋G-BIAS即 GPS-Based Integrated Application System系統(tǒng)應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)或規(guī)范軟硬件環(huán)境

21、（包括運(yùn)行環(huán)境與開發(fā)環(huán)境）的約束接口 / 協(xié)議的約束用戶界面的約束* 軟件質(zhì)量約束，包括正確性，健壯性，可靠性，效率（性能），易用性，清晰性，安全性，可擴(kuò)展性，兼容性，可移植性。（如果有約束，逐一填寫；如果不存在約束，可不填）擴(kuò)展策略為了方便擴(kuò)展，現(xiàn)在采取的措施復(fù)用策略說明本系統(tǒng)在當(dāng)前以及將來的復(fù)用策略折衷策略如果存在兩個(gè)主要目標(biāo)難以同時(shí)優(yōu)化時(shí)如何折衷軟件硬件網(wǎng)絡(luò)主要開發(fā)工具及語言軟件包括操作系統(tǒng)，第三方軟件平臺(tái)硬件網(wǎng)絡(luò)數(shù)據(jù)庫資料配置編號(hào)來源12其他說明如果系統(tǒng)比較復(fù)雜，首先將系統(tǒng)分解成若干子系統(tǒng)，對(duì)各個(gè)子系統(tǒng)繪制邏輯圖，說明子系統(tǒng)的功能* 解釋如何以及為什么如此分解系統(tǒng)說明子系統(tǒng)間如何如何協(xié)

22、調(diào)工作，以實(shí)現(xiàn)元系統(tǒng)的功能如果子系統(tǒng) N 仍然需要分解成模塊，則（ 1） 繪制模塊邏輯圖（ 2） 陳述分解理由（ 3） 說明模塊間如何協(xié)調(diào)工作，從而實(shí)現(xiàn)子系統(tǒng)的功能如果系統(tǒng)相對(duì)簡(jiǎn)單，給出用工具Visio 繪制的系統(tǒng)邏輯結(jié)構(gòu)圖界面設(shè)計(jì)報(bào)告界面設(shè)計(jì)報(bào)告（ S）配置編號(hào)EPF2003NOX-05-S-02作者時(shí)間2003-8-19當(dāng)前版本V1.20歷史版本V1.00 ，v1.07 ， v1.17繪制界面視圖界面結(jié)構(gòu)及風(fēng)格（ 1）主界面：需要給出界面元素的作用與操作（ 2）子界面：給出子界面的主要作用第三方界面元素控件，組件，函數(shù)庫及其來源名稱來源作用12數(shù)據(jù)庫設(shè)計(jì)報(bào)告主要完成數(shù)據(jù)庫的物理設(shè)計(jì)，即表的

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

24、*All rights reserved* 文件名稱：* 文件標(biāo)識(shí)：文件標(biāo)識(shí)可以統(tǒng)一規(guī)定，也可以自己選擇* 摘要：簡(jiǎn)要描述該文件的內(nèi)容* 當(dāng)前版本：* 作者：輸入作者或修改者的名字* 完成日期：* 取代版本：* 原作者 ：* 完成日期：（ 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ù)的作用配置編號(hào)當(dāng)

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

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

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

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

29、約是整個(gè)研發(fā)周期的1/41/3 。但是，鑒于公司的實(shí)際情況，需要制定有效的，符合公司使用要求，實(shí)用的測(cè)試規(guī)程。產(chǎn)品測(cè)試規(guī)定為兩個(gè)部分（ 1） 內(nèi)部測(cè)試：即指開發(fā)人員自己進(jìn)行的測(cè)試工作，基本要求是在一般情況下，產(chǎn)品能夠正常啟動(dòng)運(yùn)行即可（ 2） 產(chǎn)品測(cè)試：當(dāng)內(nèi)部測(cè)試完成以后，測(cè)試人員進(jìn)行產(chǎn)品測(cè)試，測(cè)試的依據(jù)為項(xiàng)目建議書，概要設(shè)計(jì)報(bào)告，功能定義報(bào)告，詳細(xì)設(shè)計(jì)報(bào)告（ 3） 集成測(cè)試：及產(chǎn)品的各個(gè)功能部分一起運(yùn)作下的測(cè)試產(chǎn)品測(cè)試在目前看來，最主要的是要測(cè)試產(chǎn)品的功能，測(cè)試功能的主要依據(jù)則是功能定義報(bào)告。在產(chǎn)品測(cè)試前，開發(fā)人員必須提供一套測(cè)試樣本。產(chǎn)品測(cè)試報(bào)告（HP1）配置編號(hào)EPF2003NOX-07-H-01測(cè)試人負(fù)責(zé)人測(cè)試時(shí)間2003-8-21產(chǎn)品名稱版本歷史版本測(cè)試環(huán)境及工具測(cè)試項(xiàng)功能是否通過備注1 YesNo2遺留問題問題描述問題級(jí)別原因分析1 RY O2測(cè)試結(jié)論測(cè)試人簽字手寫問題級(jí)別：（ 1）R: 即 Red，紅色級(jí)別，重大問題，關(guān)鍵問題，如執(zhí)行某項(xiàng)功能時(shí)，導(dǎo)致系統(tǒng)死機(jī)（死循環(huán)），崩潰等（ 2） Y: 即 Yellow ，黃色級(jí)別，功能性問題，某項(xiàng)功能無法通過（ 3） O:即 Orange，橙色級(jí)別，功能可以實(shí)現(xiàn)，但操作十分不便產(chǎn)品測(cè)試報(bào)告（ HP2）配置編號(hào)EPF2003