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

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

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

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

4、）， 從中選擇你需要的文檔模板的名稱(chēng)，點(diǎn)擊后，將鏈接到該模 板中，然后從“文檔編號(hào)申請(qǐng)系統(tǒng)”（建設(shè)中）中自行申請(qǐng) 文檔編號(hào)，申請(qǐng)完成后，將模板按申請(qǐng)的文件名命名并另存 到本地，即可使用。5文檔管理流程5.1內(nèi)部文檔的管理流程編寫(xiě)一個(gè)新的文檔，需要遵循以下步驟；1. 新建一個(gè)文檔前首先在“文檔編號(hào)申請(qǐng)系統(tǒng)”中自 行申請(qǐng)一個(gè)文件編號(hào)；2. 然后編寫(xiě)人員到“文檔模板庫(kù)”中選擇相應(yīng)的文檔 模板（詳見(jiàn)“4文檔模板”）；3. 編寫(xiě)人完成一次編寫(xiě)后，可將文檔Checkin到VSS 的“個(gè)人文檔庫(kù)”中備份，需要修改時(shí)再?gòu)腣SS中Checkout 到本地進(jìn)行修改，修改完成后再Checkin到VSS中，如此反 復(fù)

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

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

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

8、調(diào)）個(gè)子目錄, 一個(gè)“PersonalFile”目錄。其中的24個(gè)子目錄由文檔管 理員管理，并設(shè)有相應(yīng)的訪(fǎng)問(wèn)權(quán)限，目前只有文檔管理員及 總工辦有訪(fǎng)問(wèn)權(quán)限；“個(gè)人文檔庫(kù)”則為每個(gè)人設(shè)置了一個(gè) 文件夾，并由個(gè)人維護(hù)管理。7文檔權(quán)限控制所有文檔的最終版本必須嚴(yán)格保密，防止泄露。因此要 對(duì)所有文檔進(jìn)行權(quán)限控制。目前，“Technical”目錄的訪(fǎng)問(wèn)權(quán)限只對(duì)總工辦和文檔 管理員開(kāi)放；“個(gè)人文檔庫(kù)”目錄下，每個(gè)人只有訪(fǎng)問(wèn)自己 文件夾目錄的權(quán)限。8文檔備份所有文檔采用雙保險(xiǎn)備份。一是通過(guò)硬件（光盤(pán)刻錄）來(lái)實(shí)現(xiàn)備份，由網(wǎng)管定期完 成。主要說(shuō)明如下：在VSS中，給網(wǎng)管設(shè)置“只讀”權(quán)限，由網(wǎng)管定期（每 月最后一個(gè)

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

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

11、idding-fig 02.Negotiation一畫(huà) 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一畫(huà) 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知.五號(hào)線(xiàn)項(xiàng)目文檔管理目錄結(jié)構(gòu)根據(jù)CMM標(biāo)準(zhǔn)將各階段所需要編制的文檔至少包括以下種類(lèi):文檔類(lèi)型階段劃分輸出文檔模板備注項(xiàng)目管理立項(xiàng)管理立項(xiàng)預(yù)算申請(qǐng)立項(xiàng)調(diào)查報(bào)告立項(xiàng)可行性分析報(bào)告立項(xiàng)建議書(shū)立項(xiàng)評(píng)審報(bào)告結(jié)項(xiàng)管理結(jié)

13、項(xiàng)申請(qǐng)書(shū)結(jié)項(xiàng)評(píng)審報(bào)告項(xiàng)目規(guī)劃項(xiàng)目估計(jì)報(bào)告項(xiàng)目計(jì)劃項(xiàng)目SQA計(jì)劃項(xiàng)目SCM計(jì)劃項(xiàng)目計(jì)劃變更控制報(bào) 告項(xiàng)目執(zhí)行組織機(jī)構(gòu)圖項(xiàng)目風(fēng)險(xiǎn)計(jì)劃項(xiàng)目監(jiān)控項(xiàng)目監(jiān)控?cái)?shù)據(jù)表 項(xiàng)目偏差控制報(bào)告項(xiàng)目控制進(jìn)度表項(xiàng)目進(jìn)展報(bào)告項(xiàng)目評(píng)審報(bào)告用戶(hù)需求需求評(píng)審報(bào)告需求跟蹤報(bào)告需求變更控制報(bào)告配置管理配置管理計(jì)劃配置庫(kù)管理報(bào)告文檔類(lèi)型階段劃分輸出文檔模板備注配置項(xiàng)變更控制報(bào)告月度進(jìn)度報(bào)告培訓(xùn)管理機(jī)構(gòu)培訓(xùn)計(jì)劃項(xiàng)目培訓(xùn)計(jì)劃?rùn)C(jī)構(gòu)培訓(xùn)通知項(xiàng)目培訓(xùn)通知機(jī)構(gòu)培訓(xùn)評(píng)估報(bào)告項(xiàng)目培訓(xùn)評(píng)估報(bào)告產(chǎn)品維護(hù)客戶(hù)服務(wù)計(jì)劃客戶(hù)服務(wù)報(bào)告產(chǎn)品維護(hù)計(jì)劃產(chǎn)品維護(hù)報(bào)告會(huì)議記錄會(huì)議記錄單日志管理日?qǐng)?bào)周報(bào)月報(bào)項(xiàng)目研發(fā)需求開(kāi)發(fā)用戶(hù)需求說(shuō)明書(shū)產(chǎn)品需求規(guī)格說(shuō)明書(shū)系統(tǒng)設(shè)計(jì)體系結(jié)構(gòu)設(shè)計(jì)

14、功能閨閣書(shū)詳細(xì)設(shè)計(jì)用戶(hù)界面設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì)模塊設(shè)計(jì)與相關(guān)接口的設(shè)計(jì) 所有軟件設(shè)計(jì)階段文 檔：軟件流程圖軟件源代碼文檔類(lèi)型階段劃分輸出文檔模板備注軟件清單代碼檢查單 技術(shù)復(fù)查活動(dòng)檢查單版本檢查單測(cè)試記錄檢查單BUG處理流程檢查單 安裝手冊(cè)檢查單 評(píng)審活動(dòng)檢查單實(shí)現(xiàn)與測(cè)試實(shí)現(xiàn)與測(cè)試計(jì)劃編程文檔代碼審查報(bào)告測(cè)試用例測(cè)試報(bào)告缺陷管理報(bào)告測(cè)試驗(yàn)收記錄系統(tǒng)測(cè)試系統(tǒng)測(cè)試計(jì)劃系統(tǒng)測(cè)試用例系統(tǒng)測(cè)試報(bào)告缺陷管理報(bào)告驗(yàn)收測(cè)試«Beta測(cè)試協(xié)議Beta測(cè)試報(bào)告客戶(hù)驗(yàn)收客戶(hù)驗(yàn)收計(jì)劃驗(yàn)收測(cè)試用例客戶(hù)驗(yàn)收?qǐng)?bào)告技術(shù)評(píng)審整個(gè)項(xiàng)目的技術(shù)評(píng)審計(jì)劃技術(shù)評(píng)審?fù)ㄖ夹g(shù)評(píng)審報(bào)告文檔類(lèi)型階段劃分輸出文檔模板備注常用的技術(shù)評(píng)審檢查表輸

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

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