軟件公司AFC技術文檔編制管理規(guī)范.docx

1、軟件公司AFC技術文檔編制管理規(guī)范1概述1.1目的統(tǒng)一投標文件的表現和外觀，規(guī)范文檔管理，簡化文檔 格式化和管理的工作量。技術文檔的編制管理主要是為了將開發(fā)過程中各個階 段的文檔進行統(tǒng)一規(guī)范的管理，包括系統(tǒng)開發(fā)設計類文檔、 測試類文檔、用戶使用類文檔以及交流類文檔等，并進一步 的做到完善、更新和添加。管理規(guī)范主要包括：1. 制定文檔的命名和編碼規(guī)則；2. 制定文檔的格式規(guī)范；（包括所有不同種類的文檔、 表格、圖表等）3. 目錄管理；（包括目錄的建立，索引文檔，目錄變更 等）4. 版本以及狀態(tài)管理；5. 文檔權限控制;（根據項目的分工對文檔進行分類管 理）6. 文檔匯總；（定期查看文檔狀態(tài)，做階

2、段性匯總）7. 文檔備份。表3.文檔類型編碼表序號專用名詞描述1SLEAFC專用終端設備2AG自動檢票機3DG末端AG4EnG進站AG5ExG出站AG6RG雙向AG7TVM自動售票機8BOM半自動售票機9E/S編碼分揀機10EB緊急按鈕11EQM自動查詢機12PCA便攜式檢票機13ECU主控單元14PC個人計算機15OCC控制中心16LCD薄膜晶體管液晶顯示器17UPS不間斷電源18WS工作站19SAM安全模塊20TC票務中心21SC車站計算機系統(tǒng)22LC中心計算機系統(tǒng)23MC維修中心24ss軟件系統(tǒng)25NS網絡系統(tǒng)序號專用名詞描述26PSS電源系統(tǒng)27CGS頂棚導向標識表4.文檔類型編碼表N

3、O編碼表示說明1CN中文簡體中文文檔2EN英文英文文檔3JP日文日文文檔表5.文檔語言編碼表3.1.2接收、發(fā)送的文檔命名規(guī)則所有在VSS控制的文檔都使用“文檔編號”命名（見圖2）；所有與外部交流的文檔都使用“文件名稱”命名（見圖 2）。例如：與OMRON、其他合作伙伴等交換的文檔，需要在 “_CN”后追加內部版本號以及保存、交換的日期號。交換文檔由文檔管理員負責統(tǒng)一發(fā)送和接收。4文檔模板所有文檔的編寫必須套用指定的模板，不允許個人對文 檔模板進行修改，有任何問題可與文檔管理員交流，并由文 檔管理員統(tǒng)一進行修改。模板選擇步驟如下：打開目錄（正在完善中）下的“文檔模板庫"（excel表

4、）， 從中選擇你需要的文檔模板的名稱，點擊后，將鏈接到該模 板中，然后從“文檔編號申請系統(tǒng)”（建設中）中自行申請 文檔編號，申請完成后，將模板按申請的文件名命名并另存 到本地，即可使用。5文檔管理流程5.1內部文檔的管理流程編寫一個新的文檔，需要遵循以下步驟；1. 新建一個文檔前首先在“文檔編號申請系統(tǒng)”中自 行申請一個文件編號；2. 然后編寫人員到“文檔模板庫”中選擇相應的文檔 模板（詳見“4文檔模板”）；3. 編寫人完成一次編寫后，可將文檔Checkin到VSS 的“個人文檔庫”中備份，需要修改時再從VSS中Checkout 到本地進行修改，修改完成后再Checkin到VSS中，如此反 復

5、進行（可保存原始文檔和修改記錄），直到完成最終文檔。（本條只作為建議）4. 編寫人員將最終提交的文件按時放在VSS的“個人 文檔庫”中的個人目錄下，并以郵件或口頭通知的方式通知 文檔管理員接收。需要版本升級的文檔，編寫人員將修改后 的文檔再次提交文檔管理員，由文檔管理員將修改后的版本 更新到VSS,同時更新文檔索引（見2. 2文檔索引），保證文 檔版本的最新狀態(tài)。5. 如果需要查看VSS中保存的文檔，可與文檔管理員 聯系，由文檔管理員對其開放該文檔的只讀權限，在文檔參 考完畢后收回權限。5. 2與外部文檔交互管理1. 我方與外部（如OMRON或其他分包商等）交互的文 檔，文檔管理員要在文檔交互

6、登記表中登記，詳細記錄 發(fā)出文檔或接收文檔的名稱、編號、交互時間、接收人、發(fā) 出人等內容；2. OMRON、其他分包商等外部提供的項目文檔，必須嚴 格遵循的文檔命名規(guī)范，詳細說明見“3.1.2交換文檔命名 規(guī)則”；（由文檔管理員與對方文檔命名負責人協(xié)調）3. 接收到的外部文檔，由文檔管理員對其格式進行標 準化，然后Checkin到VSS中存檔。6文檔管理、版本控制6. 1 VSS的安裝1）版本管理采用VirtualSourceSafe6. 0,每人必須安 裝該軟件客戶端軟件。該軟件目錄在 bf i-f ilesvrsof11 ibDevelopVisualC+6. 0 目錄下, 運行Setup

7、之后，選擇安裝product，僅安裝 VirtualSourceSafe6. 0 即可。2）路徑為：Afc_svrAFCVSS$,登陸名稱與域登陸 名相同，初始密碼為空。如郭建紅登陸名為：Guo_jianhongo3）VSS上共有兩個庫，一個是文檔管理庫，由文檔管 理員統(tǒng)一進行管理，控制所有編制完成的項目文檔，并設定 相應的訪問權限；另一個是個人文檔備份庫，為每個人設一 個文件夾，由個人維護管理，但相互之間無法訪問。4）VSS的管理結構主要分為三個部分，分別是Docs、Manage> Releaseo其中，技術文檔放在Docs目錄下的 Technical中按項目的時間段分成了 24 （可

8、調）個子目錄, 一個“PersonalFile”目錄。其中的24個子目錄由文檔管 理員管理，并設有相應的訪問權限，目前只有文檔管理員及 總工辦有訪問權限；“個人文檔庫”則為每個人設置了一個 文件夾，并由個人維護管理。7文檔權限控制所有文檔的最終版本必須嚴格保密，防止泄露。因此要 對所有文檔進行權限控制。目前，“Technical”目錄的訪問權限只對總工辦和文檔 管理員開放；“個人文檔庫”目錄下，每個人只有訪問自己 文件夾目錄的權限。8文檔備份所有文檔采用雙保險備份。一是通過硬件（光盤刻錄）來實現備份，由網管定期完 成。主要說明如下：在VSS中，給網管設置“只讀”權限，由網管定期（每 月最后一個

9、工作日下午16點）將"Technical"目錄下的所 有文件進行備份，刻錄在光盤上進行保存。如果有特殊情況, 比如某段時間輸出的文檔很多，為了保險起見由文檔管理員 臨時通知網管進行隨時備份。備份后的光盤由文檔管理員統(tǒng) 一編號保管。（具體事宜由文檔管理員與網管溝通）二是通過文檔管理員進行電子備份，說明如下：文檔管理員定期（每月第2、4個星期的下午17點）將 “Technical”目錄下的所有文件備份在用戶名為AFC2的文 檔備份機器上，并設置訪問權限。1.2使用范圍AFC技術部編制的所有文檔強制遵循本規(guī)范。1.3適用人員文檔管理和使用人員。2目錄管理2.1文檔目錄的創(chuàng)建整個項

10、目過程的文檔將通過服務器(AFC.SVR),采用VSS 進行管理。文檔管理目錄按項目進展的時間段進行劃分。各 類文檔按照不同階段的需要進行分類：B宣 $/B-&北京地鐵五號線項目S-fitf Docs牛-通 Businessb 食 persqnalFilej一宣 dai_xiaot ao一際 guo_jianhong-fid jia_jian一鯉 lian_gang一畫 sui_lili-fig wang_zhaohua一阻 wang_zhihua一畫 xu_jie一宣 zhang_li1遂犯 zhao_wenB-fiaj Technical00. Material-fig 01. B

11、idding-fig 02.Negotiation一畫 03. Design The Contact一倒 04. Advanced developmen一旬 05. Volume Productionfig 06. Software Requiremen-fig 07.Preliminary Design-fig 08.Detailed Design-fid 09. Coding-fig 10. Test一畫 11. Preparations For Co-IlKi 12. Working Design-Ji 13. Site Operation-fig 14.Stock-fig 15. In

12、stallation-fii 16. Adjust and Test-fifi 17. Commissioning-M 18. Check and Accept一滋| 19. After Service-fig 20.Training甲宣 21. Meeting-fig 22. Manual-M 23. Equipment Supplier H 24. Project Management知.五號線項目文檔管理目錄結構根據CMM標準將各階段所需要編制的文檔至少包括以下種類:文檔類型階段劃分輸出文檔模板備注項目管理立項管理立項預算申請立項調查報告立項可行性分析報告立項建議書立項評審報告結項管理結

13、項申請書結項評審報告項目規(guī)劃項目估計報告項目計劃項目SQA計劃項目SCM計劃項目計劃變更控制報 告項目執(zhí)行組織機構圖項目風險計劃項目監(jiān)控項目監(jiān)控數據表 項目偏差控制報告項目控制進度表項目進展報告項目評審報告用戶需求需求評審報告需求跟蹤報告需求變更控制報告配置管理配置管理計劃配置庫管理報告文檔類型階段劃分輸出文檔模板備注配置項變更控制報告月度進度報告培訓管理機構培訓計劃項目培訓計劃機構培訓通知項目培訓通知機構培訓評估報告項目培訓評估報告產品維護客戶服務計劃客戶服務報告產品維護計劃產品維護報告會議記錄會議記錄單日志管理日報周報月報項目研發(fā)需求開發(fā)用戶需求說明書產品需求規(guī)格說明書系統(tǒng)設計體系結構設計

14、功能閨閣書詳細設計用戶界面設計數據庫設計模塊設計與相關接口的設計 所有軟件設計階段文 檔：軟件流程圖軟件源代碼文檔類型階段劃分輸出文檔模板備注軟件清單代碼檢查單 技術復查活動檢查單版本檢查單測試記錄檢查單BUG處理流程檢查單 安裝手冊檢查單 評審活動檢查單實現與測試實現與測試計劃編程文檔代碼審查報告測試用例測試報告缺陷管理報告測試驗收記錄系統(tǒng)測試系統(tǒng)測試計劃系統(tǒng)測試用例系統(tǒng)測試報告缺陷管理報告驗收測試«Beta測試協(xié)議Beta測試報告客戶驗收客戶驗收計劃驗收測試用例客戶驗收報告技術評審整個項目的技術評審計劃技術評審通知技術評審報告文檔類型階段劃分輸出文檔模板備注常用的技術評審檢查表輸

15、出文檔安裝類文檔所有安裝、配置圖紙 所有系統(tǒng)、設備的安裝說 明書用戶手冊所有用戶操作手冊、維修手冊培訓類文檔所有培訓手冊和資料表1文檔模板列表2.2文檔索引按照各階段所需要輸出的文檔內容，建立文檔狀態(tài)跟蹤 列表（項目包括文檔名稱、編號、版本號、最后變更日期、 狀態(tài)等），保證隨時能夠查閱最新文檔。3文檔命名規(guī)范3. 1文檔命名規(guī)則3.1.1 一般文檔命名規(guī)則文檔統(tǒng)一使用全英文命名方式。文件名由六部分組成, 各部分由分隔線連接。文件命名請遵循下面規(guī)則：文檔犒號（VSS控制）文件名稱（對外交流保存）固定項目名稱縮寫（北京地鐵五號線）三組。第一組代表文檔種類編碼； 第.組為同一種類文檔順序號： 第三組

16、代表文檔類型編碼。三組：（建議不超過32個字符）, 第一組軟/硬產品的名稱； 第二組為功能性能縮寫；第二組為文件性質。兩位，語言編碼年、月、日：序列號版本號文檔編號規(guī)則注:所有類型的文檔編號，只能使用“1199”位的編 號，OMRON使用“200399”位的編號，即所有文檔OMRON 都從200開始編號。NO編碼表示說明1Z資料Material2K投標Bidding3N商務談判Negotiation4J設計聯絡DesignTheContact5Q樣機試制Advanceddevelopment6P批量生產VolumeProduction7S軟件需求SoftwareRequirement8G概要設計PreliminaryDesign9D詳細設計DetailedDesignNO編碼表示說明1Z資料Material10C編碼Coding11T測試Test12U施工準備PreparationsForConstruction13V施工設計WorkingDesign14W現場施工SiteOperation15B采購Stock161安裝Installation17A調測AdjustandTest180試運行Commissioning19X驗收Ch