驅(qū)動軟件開發(fā)流程規(guī)范.doc

驅(qū)動軟件開發(fā)流程規(guī)范Ver.1.1 試行1. 概述驅(qū)動軟件開發(fā)流程規(guī)范（下文簡稱本規(guī)范）的用戶：1) 軟件部經(jīng)理。2) 軟件部開發(fā)人員。3) 軟件部項目經(jīng)理。4) 技術(shù)部經(jīng)理。5) 技術(shù)部技術(shù)支持。6) 技術(shù)部測試人員。7) 其它一切參與和關注驅(qū)動軟件開發(fā)的人員。本規(guī)范的對象是軟件部的驅(qū)動軟件開發(fā)過程。開發(fā)過程涉及的內(nèi)容包括項目、產(chǎn)品和知識，三者之間的關系描述如下。項目是一個特殊的將被完成的有限任務，它是在一定時間內(nèi)，滿足一系列特定目標的多項相關工作的總稱。產(chǎn)品是項目開發(fā)輸出的結(jié)果。知識是項目開發(fā)過程中積累的經(jīng)驗和教訓。在開發(fā)過程中，項目被分為許多小型Issue（任務、缺陷）分步或并行完成；項目開發(fā)輸出產(chǎn)品，產(chǎn)品應用的信息作用到項目開發(fā)；項目開發(fā)中能提煉知識，知識可應用到項目開發(fā)。2. 驅(qū)動軟件開發(fā)管理平臺（如何搭建服務器和客戶端環(huán)境）驅(qū)動軟件開發(fā)管理平臺（下文簡稱本平臺）是實施本規(guī)范的設備和工具基礎，本規(guī)范就是為本平臺量身打造的。其物理架構(gòu)描述如下圖，用戶應根據(jù)下圖安裝相應的軟件：上圖中的模塊描述如下：模塊類型模塊描述服務器端服務器計算機服務器，IP：00Windows操作系統(tǒng)、其它支撐軟件Windows操作系統(tǒng)：Windows2003JAVA環(huán)境：jdk-1_5_0_08-windows-i586-p.exe數(shù)據(jù)庫：mysql-5.0.27-win32.zipSVN ServerSVN是Subversion的縮寫，SVN是比VSS和CVS功能更加強大的文件版本控制工具，SVN可理解為CS結(jié)構(gòu)。SVN Server即SVN的服務端，與SVN Client共一個安裝程序：Subversion 1.4.0，安裝后自帶命令行工具Tortoise SVNTortoise SVN構(gòu)建于SVN之上，是SVN的圖像化界面工具，基本上可以替代SVN的自帶命令行工具。本平臺選用的版本為：Tortoise SVN 1.4.0產(chǎn)品產(chǎn)品文件。如工程源文件、輸出文件、安裝包JIRA ServerJIRA是澳大利亞Atlassian公司開發(fā)的一款優(yōu)秀的問題跟蹤及管理軟件工具，可以對各種類型的問題進行跟蹤管理，包括缺陷、任務、需求、改進等。JIRA采用J2EE技術(shù)，能夠跨平臺部署。JIRA Server即JIRA的服務端，本平臺選用的版本為：Atlassian JIRA Enterprise v3.7.2，服務器安裝成功并啟動后，只需使用普通的IE瀏覽器即可訪問JIRA Server項目包括：1) 項目文件。如項目基本信息、計劃書、進度表、設計方案。2) Issue文件。如Issue基本信息Confluence ServerConfluence是澳大利亞Atlassian公司開發(fā)的一款企業(yè)級的WIKI軟件，用在團隊成員之間彼此分享信息、文檔協(xié)作和集體討論。Conluence與JIRA集成后其功能更加強大。Confluence Server即Confluence的服務端，本平臺選用的版本為：Atlassian confluence-2.2.9-std，服務器安裝成功并啟動后，只需使用普通的IE瀏覽器即可訪問Confluence Server知識知識庫。如工具使用方法、調(diào)試方法、編程經(jīng)驗網(wǎng)絡局域網(wǎng)公司內(nèi)網(wǎng)客戶端客戶端計算機任何一臺能通過局域網(wǎng)訪問服務器的計算機Windows/Linux操作系統(tǒng)、其它支撐軟件Windows系列/Linux系列SVN ClientSVN是Subversion的縮寫，SVN是比VSS和CVS功能更加強大的文件版本控制工具，SVN可理解為CS結(jié)構(gòu)。SVN Client即SVN的客戶端，與SVN Server共一個安裝程序：Subversion 1.4.0，安裝后自帶命令行工具Tortoise SVNTortoise SVN構(gòu)建于SVN之上，是SVN的圖像化界面工具，基本上可以替代SVN的自帶命令行工具。本平臺選用的版本為：Tortoise SVN 1.4.0IExplorerInternet Explorer瀏覽器（操作系統(tǒng)自帶的瀏覽器即可）規(guī)范操作方法和操作規(guī)范具體見下文用戶服務器管理人員、軟件部：經(jīng)理/項目經(jīng)理平臺面向的用戶3. 操作方法（如何操作工具軟件）操作方法包括工具軟件的安裝、配置和使用方法，用戶閱讀時可跳過無關章節(jié)。相關安裝程序和文檔可在“00set_up_2開發(fā)工具軟件開發(fā)驅(qū)動軟件開發(fā)管理平臺”找到。3.1. JIRA3.1.1. 安裝、配置非服務器管理人員可跳過本節(jié)。中/英文名稱英jira-manual3.6.pdfjira-manual-install.pdfjira-manual-config.pdf中JIRA用戶使用指南-簡化版.pdf安裝java環(huán)境.pdf使用JIRA搭建企業(yè)問題跟蹤系統(tǒng).pdf工作流介紹.pdf3.1.2. 使用中/英文名稱英jira-manual3.6.pdfjira-manual-user.pdf中JIRA白皮書Ver2.pdfJIRA實例使用指南.pdJIRA用戶使用指南-簡化版.pdf3.1.3. 用戶帳戶管理用戶帳戶由軟件部經(jīng)理分配和管理。用戶可以通過郵件向軟件部經(jīng)理申請，郵件地址：。3.1.4. 訪問地址00:80803.2. Confluence3.2.1. 安裝、配置非服務器管理人員可跳過本節(jié)。中/英文名稱中Confluence安裝指南.pdf3.2.2. 使用暫缺，用戶可以踴躍推薦。3.2.3. 用戶帳戶管理用戶帳戶由軟件部經(jīng)理分配和管理。用戶可以通過郵件向軟件部經(jīng)理申請，郵件地址：。3.2.4. 訪問地址00:80813.3. SVN3.3.1. 安裝、配置和使用非服務器管理人員且非軟件部開發(fā)人員可跳過本節(jié)。中/英文名稱中svn-book.pdf3.3.2. 用戶帳戶管理用戶帳戶由軟件部經(jīng)理分配和管理。用戶可以通過郵件向軟件部經(jīng)理申請，郵件地址：。3.3.3. 訪問地址（建立中）3.4. Tortoise SVN3.4.1. 安裝、配置和使用非服務器管理人員且非軟件部開發(fā)人員可跳過本節(jié)。中/英文名稱中訪問/tsvn/4. 操作規(guī)范（操作工具軟件時應遵守的規(guī)范）4.1. 項目開發(fā)JIRA不同于普通的缺陷管理工具，它既可管理缺陷也可管理項目，在項目開發(fā)過程中，項目被分為許多小型Issue（任務、缺陷）分步或并行完成，當全部的Issue被解決，項目也隨之完成。本平臺使用JIRA與項目進度表結(jié)合的方式管理項目，JIRA控制Issue的進度，WORD進度表控制項目的進度。4.1.1. 項目項目有開發(fā)和維護兩個類別，分別在項目文件信息和項目開發(fā)過程有所區(qū)別，詳見下文。項目文件信息描述如下表。文件類型開發(fā)維護描述項目計劃書WORD文檔，立項時編寫，作為附件保存到項目的“文檔”（Issue名稱）。樣本見“00set_up_2開發(fā)工具軟件開發(fā)驅(qū)動軟件開發(fā)管理平臺文檔樣本項目計劃書樣本.doc”。項目基本信息JIRA字段，立項時編寫，字段信息說明如下表，字段描述Project Name項目的名稱，例如：值描述SynCTI維護SynCTI驅(qū)動平臺DOC開發(fā)和維護文檔的項目，包括硬件安裝說明書、產(chǎn)品手冊、程序員手冊等，軟件部文檔項目組專用Asterisk維護Asterisk支持Project Category項目的類別，有以下可選值：值描述開發(fā)在現(xiàn)有驅(qū)動平臺上開發(fā)新功能（如支持新型號的板卡、新增協(xié)議支持）或開發(fā)新的驅(qū)動平臺維護維護已有驅(qū)動平臺Key項目的關鍵字，由英文字母組成，值以實際設置為準Web項目的網(wǎng)址，不用Project Team項目團隊，值以實際設置為準Issue Type Scheme問題類型策略，非服務器管理人員可不關注，值以實際設置為準Notification Scheme通知策略，非服務器管理人員可不關注，值以實際設置為準Permission Scheme權(quán)限策略，非服務器管理人員可不關注，值以實際設置為準Issue Security Scheme安全策略，非服務器管理人員可不關注，值以實際設置為準Field Configuration Scheme字段配置策略，非服務器管理人員可不關注，值以實際設置為準Issue Type Screen Scheme問題類型屏幕策略，非服務器管理人員可不關注，值以實際設置為準Workflow Scheme工作流策略，非服務器管理人員可不關注，值以實際設置為準CVS ModulesCVS模塊，不用Mail Configuration郵件配置，非服務器管理人員可不關注，值以實際設置為準描述項目的概述，值以實際設置為準注：項目創(chuàng)建時項目的相關字段就已基本確定，以后一般不再修改。非服務器管理人員，無權(quán)修改項目的相關字段。項目進度表WORD文檔，項目開發(fā)過程中編寫，作為附件保存到項目的“文檔”（Issue名稱）。樣本見“00set_up_2開發(fā)工具軟件開發(fā)驅(qū)動軟件開發(fā)管理平臺文檔樣本項目進度表樣本.doc”。IssuesJIRA管理的對象，是項目開發(fā)過程中的任務或者缺陷。具體文件信息和操作規(guī)范見下文。項目開發(fā)過程描述如下圖。上圖中各個狀態(tài)的含義描述如下表。狀態(tài)名稱描述開發(fā)項目處于開發(fā)狀態(tài)，可能是預研、方案設計、編碼、調(diào)試、測試、試用或編寫文檔階段。開發(fā)過程中，可以在項目中創(chuàng)建多個Issue，這些Issue可以并行或者分步解決，當全部Issue都被解決，項目也隨之完成。Issue的說明見下文。對于開發(fā)人員來說，開發(fā)就是解決Issue的過程。對于項目經(jīng)理（或者項目負責人）來說，開發(fā)過程中必須使用項目進度表對項目進行總結(jié)和計劃（注：只有開發(fā)類的項目必須），并每周召開一次項目會議。等待評審項目已經(jīng)完成，即項目中的所有Issue都已解決。完成項目評審通過，項目結(jié)束。終止項目在開發(fā)過程中被終止，項目結(jié)束。上圖中各個操作的含義描述如下表。操作名稱開發(fā)維護立項操作前提：1) 收到上級的立項指示操作方法：1) 在JIRA中創(chuàng)建項目并填寫項目基本信息，在項目中創(chuàng)建“文檔”（Issue）2) 編寫項目計劃書，作為附件保存到“文檔”（Issue）3) 編寫項目進度表，保存到VSS管理的“大項目進度表”（地址：00語音部開發(fā)中項目進度表）經(jīng)理必須完成以下事項：1) 在JIRA中創(chuàng)建項目并填寫項目基本信息完成操作前提：1) 項目所有的Issue都已解決2) 壓力測試通過操作方法：1) 準備評審資料，包括項目計劃書、項目進度表、測試方案、測試報告2) 申請評審操作前提：1) 項目所有的Issue都已解決2) 接到上級的指示：不再維護該產(chǎn)品操作方法：1) 申請評審評審操作方法：1) 召集項目相關人員對項目進行評審，如果項目達到預期目標則評審通過，否則再次進入開發(fā)狀態(tài)操作方法：1) 召集項目相關人員對項目進行評審，如果所有的Issue都已解決則評審通過，否則再次進入開發(fā)狀態(tài)終止操作前提：1) 接到上級的項目終止指示操作方法：1) 備份已有成果，然后終止項目操作前提：1) 接到上級的指示：不再維護該產(chǎn)品操作方法：1) 備份已有成果，然后終止項目4.1.2. IssueJIRA的Issue是指缺陷、任務、改進或新增功能，有明確的負責人、時間安排和進度描述等。Issue文件信息說明如下表。圖例：金色底紋表示自定義字段，淺青綠底紋表示由JIRA自動更新的字段。字段描述項目問題所屬項目，可選值為已創(chuàng)建的項目名稱問題類型有以下可選值：值描述Bug缺陷，已實現(xiàn)功能的缺陷，如驅(qū)動藍屏、重啟、非法操作、功能錯誤，文檔描述錯誤Improvement改進，已實現(xiàn)功能的不足，如提高語音質(zhì)量、提高驅(qū)動效率New Feature新增功能，新需求，如驅(qū)動新增API函數(shù)、新增協(xié)議支持、新增板卡支持，文檔補充Task任務，不涉及修改代碼或文檔的工作，如新增Linux內(nèi)核支持、協(xié)助硬件開發(fā)人員查問題、協(xié)助銷售人員推銷板卡、協(xié)助技術(shù)支持解決客戶的應用問題簡要描述問題的簡要描述，應簡潔明了，如“SHT-8B-CT/PCI卡收不到FSK主叫號碼”優(yōu)先級有以下可選值：值描述Blocker災難，導致系統(tǒng)崩潰，例如藍屏、重啟、非法操作，必須馬上處理Critical重要，無法使用，如狀態(tài)機遷移問題、錄音錄不到聲音、DTMF漏收Major(default)中等，可用，但是功能受到影響，如音質(zhì)不好Minor輕微，可用，但是需要改進或優(yōu)化，如Test功能不全Trivial無足輕重，如果有時間則修改截止日期預期完成的日期模塊出現(xiàn)問題的模塊影響版本問題從哪個版本開始影響修復版本問題從哪個版本開始被修復環(huán)境問題發(fā)生的環(huán)境，如板卡型號、操作系統(tǒng)等詳細描述對問題的詳細描述操作系統(tǒng)有以下可選值：值描述Common(default)Windows and Linux系列WindowsWindows系列LinuxLinux系列來源技術(shù)部OA系統(tǒng)的故障報告單號或者其它描述客戶名稱向技術(shù)支持報告問題的客戶名稱，便于銷售查詢設計要求設計要求是Issue審查通過的標準報告人（Reporter）報告者，可以是任意用戶，一般是技術(shù)支持、測試人員分派人（Assigner）分派人可以是開發(fā)人員、項目經(jīng)理或經(jīng)理。但是，開發(fā)人員只能將Issue分派給自己，項目經(jīng)理只能將Issue分派給本組開發(fā)人員分派給（Assignee）Issue接收者負責人（Issue Lead）對于開發(fā)類項目，負責人是項目計劃書上定的項目負責人。對于維護類項目，有項目經(jīng)理的Assignee負責人項目經(jīng)理，沒有項目經(jīng)理的Assignee負責人是經(jīng)理解決方式即問題關閉的原因，有以下可選值：值描述Fixed (Default)問題解決Wont Fix不解決Duplicate重復報告Incomplete描述不清Cannot Reproduce不能重現(xiàn)未解決問題尚未解決備注問題有關鍵更新時必須編寫，其內(nèi)容作為問題日志Key問題的關鍵字創(chuàng)建時間創(chuàng)建問題的日期時間更新日期上次更新的日期，對問題的任何動作都視為更新改動記錄通過JIRA的接口對問題進行修改的記錄投票對問題的解決結(jié)果進行投票表決時的票數(shù)，由投票的總?cè)藬?shù)決定關注人關注問題的總?cè)藬?shù)狀態(tài)有以下可選值：值描述Open已打開Assigned已分配In Progress處理中Resolved已解決Checked已審查Closed已關閉Reopened重新打開Issue解決過程描述如下圖。上圖中各個操作的含義描述如下表：下表圖例：茶色底紋表示必須賦值的字段，其它表示可選賦值的字段。Screen Type是指字段顯示的屏幕類型（非服務器管理人員可不關注）。操作名稱描述創(chuàng)建（SOpen）l 描述：創(chuàng)建Issuel 條件：1) Reporter確認問題需要軟件部參與解決2) Reporter搜索JIRA，確認JIRA中不存在該問題l 字段變化：字段描述項目問題類型簡要描述優(yōu)先級截止日期模塊影響版本修復版本環(huán)境詳細描述操作系統(tǒng)來源客戶名稱報告人l Screen Type：sn1分配（OpenAssigned）l 描述：為Issue分配Assigner、Assignee和Issue Leadl 條件：1) 核實通過：問題需要軟件部參與解決，并且問題的相關描述完整無誤l 字段變化：字段描述問題類型簡要描述優(yōu)先級截止日期模塊影響版本修復版本環(huán)境詳細描述操作系統(tǒng)來源客戶名稱設計要求報告人分派人分派給負責人備注l Screen Type：sn2l JIRA自動郵件通知：Reporter、Assignee、Issue Lead關閉（OpenClosed）l 描述：關閉Issuel 條件：1) 核實不通過：問題不需要軟件部參與解決或問題相關描述不清楚，解決方式可以是：Wont Fix、Duplicate、Incomplete或Cannot Reproducel 字段變化：字段描述解決方式分派人備注寫明具體原因l Screen Type：sn3l JIRA自動郵件通知：Reporter接收（AssignedIn Progress）l 描述：接收并開始處理Issuel 字段變化：字段描述備注l Screen Type：sn4l JIRA自動郵件通知：Reporter、Issue Lead解決（In ProgressResolved）l 描述：完成處理、升級或終止Issuel 條件：1) 開發(fā)結(jié)束，解決方式可以是：Fixed、Wont Fix、Duplicate、Incomplete或Cannot Reproducel 字段變化：字段描述解決方式備注寫明具體原因l Screen Type：sn5l JIRA自動郵件通知：Reporter、Issue Leadl 備注：如果Issue需要測試，必須將測試方案（樣本見“00set_up_2開發(fā)工具軟件開發(fā)驅(qū)動軟件開發(fā)管理平臺文檔樣本測試方案樣本.doc”）以附件保存到JIRA提交測試（ResolvedChecked）l 描述：提交技術(shù)部測試l 條件：1) 審查通過：如果解決方式是Fixed，代碼、測試方案達標；如果解決方式是其它，理由充分2) Issue需要技術(shù)部測試l 字段變化：字段描述備注l Screen Type：sn4l JIRA自動郵件通知：Reporter、Assignee、陳瑩關閉（ResolvedClosed）l 描述：關閉Issuel 條件：1) 審查通過：如果解決方式是Fixed，代碼、測試方案達標；如果解決方式是其它，理由充分2) Issue不需要技術(shù)部測試l 字段變化：字段描述備注l Screen Type：sn4l JIRA自動郵件通知：Reporter、Assignee審查通不過（ResolvedReopened）l 描述：審查通不過，需要繼續(xù)處理l 條件：1) 審查通不過：如果解決方式是Fixed，代碼、測試方案不達標；如果解決方式是其它，理由不充分l 字段變化：字段描述備注注：JIRA自動設置“解決方式”字段為未解決l Screen Type：sn4l JIRA自動郵件通知：Reporter、Assignee關閉（CheckedClosed）l 描述：關閉Issuel 條件：1) 測試通過l 字段變化：字段描述備注l Screen Type：sn4l JIRA自動郵件通知：Reporter、Assignee、Issue Lead測試通不過（CheckedReopened）l 描述：測試通不過，需要繼續(xù)處理l 條件：1) 測試通不過l 字段變化：字段描述備注注：JIRA自動設置“解決方式”字段為未解決l Screen Type：sn4l JIRA自動郵件通知：Reporter、Assignee、Issue Lead重新打開（ClosedReopened）l 描述：問題需要重新打開繼續(xù)處理l 條件：1) 如果解決方式是Fixed，經(jīng)過確認問題沒有解決；如果解決方式是其它，問題的描述被完善l 字段變化：字段描述問題類型簡要描述優(yōu)先級截止日期模塊影響版本修復版本環(huán)境詳細描述操作系統(tǒng)來源客戶名稱設計要求報告人分派人分派給負責人備注注：JIRA自動設置“解決方式”字段為未解決l Screen Type：sn2l JIRA自動郵件通知：Assignee、Issue Lead接收（ReopenedIn Progress）l 描述：接收并開始處理Issuel 字段變化：字段描述備注l Screen Type：sn4l JIRA自動郵件通知：Reporter、Issue Lead4.2. 產(chǎn)品升級每個項目都有相應的產(chǎn)品，產(chǎn)品升級是項目開發(fā)的結(jié)果。產(chǎn)品文件包括源文件、輸出文件和安裝包，源文件和輸出文件由SVN管理，安裝包由技術(shù)部負責管理。文件流轉(zhuǎn)過程描述如下圖：Issue進入“Resolved”狀態(tài)前由開發(fā)人員完成編譯/轉(zhuǎn)換/拷貝，產(chǎn)品發(fā)布前由技術(shù)部完成打包。SVN庫的目錄結(jié)構(gòu)舉例說明如下：庫名稱子目錄名稱XXXTrunkBranches4900（待發(fā)布分支）項目XXX（開發(fā)分支B）耗時、復雜、代碼改動大的Issue XXX（開發(fā)分支B）Tags4731（已發(fā)布分支）4800（已發(fā)布分支）SVN庫的操作流程圖：SVN庫的操作流程說明：流程名稱描述開發(fā)項目l 如