文檔控制規(guī)范

1、耀邦軟件規(guī)范文檔管理規(guī)范版本 2.2配置管理文檔類別:文檔名稱:文檔標(biāo)識(shí):ybsw-doc版本:22狀態(tài):草稿訪問(wèn)路徑:ybsw_vobtech模板:ybsw-t mpl-word.dot v1.0所有人:SEPG作者/創(chuàng)建時(shí)間:2005-11-28耀邦軟件規(guī)范 文檔管理規(guī)范批準(zhǔn)人/批準(zhǔn)時(shí)間:修訂歷史:日期版本說(shuō)明作者2005-11-121.01、列出已識(shí)別的文檔清單及其代碼2、定義文檔的標(biāo)識(shí)規(guī)則3、給出一般文檔的格式規(guī)范2005-11-191.11、重新細(xì)化分類所有文檔（對(duì)命名方式無(wú)影響）2、添加周報(bào)命名方式3、添加紅色字體的注釋信息2005-11-211.21、取消文件名中的版本號(hào)2、增加

2、“任務(wù)單”、“業(yè)務(wù)分析規(guī)格說(shuō)明書”和“系統(tǒng)部署文檔”的標(biāo)識(shí)3、文件名中添加“文檔類別”項(xiàng)4、增加無(wú)版本文檔的標(biāo)識(shí)規(guī)范5、增加文檔命名的樣例2005-11-221.31、增加對(duì)文檔修訂的規(guī)定2、用藍(lán)色字體標(biāo)識(shí)本次修改的部分2005-11-231.4修訂版本號(hào)標(biāo)識(shí)規(guī)則2005-11-232.0正式發(fā)布2.0版2005-11-262.1修訂一處微小錯(cuò)誤2005-11-282.21、修改SCM審計(jì)報(bào)告的代碼2、增加“參考編碼規(guī)則”3、改“變更請(qǐng)求”為“變更申請(qǐng)”1. 簡(jiǎn)介目的1.2 范圍1.3 讀者2.文檔類別3.文檔清單4.文檔標(biāo)識(shí)4.1 帶版本文檔4.1.1 標(biāo)識(shí)號(hào)ID)4.1.2 版本號(hào)4.2

3、無(wú)版本文檔4.2.1項(xiàng)目文檔4.2.2員工周報(bào)5. 文檔格式6. 文檔修訂目錄101011文檔管理1. 簡(jiǎn)介1.1目的編制本文檔的目的在于為所有的項(xiàng)目文檔的命名、編碼以及版本號(hào)的確定建立一套統(tǒng)一的規(guī) 則和方法，以唯一地確定項(xiàng)目的每一產(chǎn)出物。1.2范圍本文檔僅描述項(xiàng)目級(jí)文檔的管理規(guī)則，不包括公司級(jí)文檔。1.3讀者所有軟件工程人員應(yīng)該閱讀本文檔，并遵從本文檔的規(guī)則識(shí)別項(xiàng)目中產(chǎn)生的文檔，并對(duì)其進(jìn) 行標(biāo)識(shí)以及按照規(guī)范的格式撰寫文檔。2. 文檔類別類別說(shuō)明代碼管理類各種有關(guān)項(xiàng)目策劃、度量、跟蹤、調(diào)整的文檔MNG需求類各種與業(yè)務(wù)和需求相關(guān)的文檔、模型REQ設(shè)計(jì)類各種設(shè)計(jì)文檔、模型等DSN實(shí)施類與軟件開發(fā)和

4、集成相關(guān)的文檔IMP測(cè)試類測(cè)試相關(guān)文檔、數(shù)據(jù)等TST發(fā)布類發(fā)布聲明以及各種用戶文檔RELSCM類SCM系統(tǒng)相關(guān)文檔及 SCM報(bào)告SCMSQA類SQA計(jì)劃及報(bào)告SQA參考資料類各種參考資料REF3. 文檔清單序號(hào)文檔中文名稱文檔英文名稱文檔代碼模板評(píng)審級(jí)別管理類（MNG）1立項(xiàng)申請(qǐng)P roject Establish RequestPER/組織級(jí)2項(xiàng)目任務(wù)書Stateme nt of WorkSOW/組織級(jí)3軟件開發(fā)計(jì)劃Software Development PlanSDPybsw-t mp 1-mn g-sdp. dot組織級(jí)4軟件開發(fā)日程表Software DevelopmentSched

5、uleSDS/組織級(jí)5軟件維護(hù)計(jì)劃Software Maintainance PlanSMP/組織級(jí)6任務(wù)單Task FormTASK/7項(xiàng)目度里報(bào)告P roject Measureme nt ReportPMR/8項(xiàng)目跟蹤報(bào)告P roject Track ing ReportPTR/9項(xiàng)目總結(jié)報(bào)告P roject Summary ReportPSR/組織級(jí)需求類（REQ）1可行性分析報(bào)告Feasibility An alysis ReportFAR/組織級(jí)2業(yè)務(wù)分析規(guī)格說(shuō)明書Busin ess An alysisSp ecificati onBAS/組織級(jí)3前景與范圍Visi on and

6、ScopeVNS/組織級(jí)4軟件需求規(guī)格說(shuō)明書Software Requirme ntSp ecificati onSRSybsw-t mp l-reqsrs.dot組織級(jí)設(shè)計(jì)類（DSN ）1總體設(shè)計(jì)說(shuō)明書Gen eral Desig n Sp ecificati onGDS/項(xiàng)目級(jí)2數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書Database Desig nSp ecificati onDBDS/項(xiàng)目級(jí)3用戶界面設(shè)計(jì)說(shuō)明書User In terface Desig nSp ecificati onUIDS/項(xiàng)目級(jí)4接口設(shè)計(jì)說(shuō)明書In terface Desig nSp ecificati onIDS/項(xiàng)目級(jí)5詳細(xì)設(shè)計(jì)說(shuō)明

7、書Detailed Desig nSp ecificati onDDS/項(xiàng)目級(jí)實(shí)施類（IMP ）1軟件配置清單Software Con figurati on ListSCL/項(xiàng)目級(jí)2軟件開發(fā)文件Software Devel opment FileSDF/項(xiàng)目級(jí)3系統(tǒng)部署文檔System DeploymentDocume ntSDD/項(xiàng)目級(jí)測(cè)試類（TST）1單元測(cè)試用例Unit Test CaseUTC/2單元測(cè)試數(shù)據(jù)Unit Test DataUTD/3單元測(cè)試腳本Un it Test ScriptUTS/4單元測(cè)試報(bào)告Unit Test ReportUTR/項(xiàng)目級(jí)5集成測(cè)試用例In teg

8、rati on Test CaseITC/6集成測(cè)試數(shù)據(jù)In tegrati on Test DataITD/7集成測(cè)試腳本In tegrati on Test ScriptITS/8集成測(cè)試報(bào)告In tegratio n Test ReportITR/項(xiàng)目級(jí)9系統(tǒng)測(cè)試用例System Test CaseSTC/10系統(tǒng)測(cè)試數(shù)據(jù)System Test DataSTD/11系統(tǒng)測(cè)試腳本System Test ScriptSTS/12系統(tǒng)測(cè)試報(bào)告System Test ReportSTR/組織級(jí)發(fā)布類（REL ）1產(chǎn)品技術(shù)白皮書Product Tech ni calWhite paperPTW/組

9、織級(jí)2系統(tǒng)安裝手冊(cè)System In stallati on ManualSIM/組織級(jí)3用戶操作手冊(cè)User Op erati on Man ualUOM/組織級(jí)4產(chǎn)品維護(hù)手冊(cè)P roduct MaintainanceMan ualPMM/組織級(jí)5產(chǎn)品培訓(xùn)資料Product Trai ning MaterialsPTM/組織級(jí)6產(chǎn)品發(fā)布聲明P roduct Release NotePRN/組織級(jí)SCM 類（SCM ）1System Request FormRFybsw-t mp l-scm-sr項(xiàng)目級(jí)建庫(kù)申請(qǐng)表f.dot2建庫(kù)驗(yàn)證報(bào)告System Verify ReportVR/3SCM審計(jì)

10、報(bào)告SCM Audit ReportAR/4變更申請(qǐng)表Change RequestCR/項(xiàng)目級(jí)SQA 類（SQA）1SQA報(bào)告SQA ReportRPT/2SQA問(wèn)題報(bào)告Issue ReportIR/其它1評(píng)審報(bào)告Review ReportRRybsw-t mp l-rr.dot/2員工周報(bào)Weekly ReportWRybsw-t mp l-wr.xis/對(duì)于以上文檔清單中未列出的文檔，可參考以下編碼規(guī)則以確定其代碼:參考編碼規(guī)則中文名稱英文名稱代碼中文名稱英文名稱代碼計(jì)劃P la nPLN樣例Samp leSMPL模型ModelMDL文檔Docume ntDOC數(shù)據(jù)DataDATA工具To

11、olTOOL腳本ScriptSCR P報(bào)告Rep ortRPT問(wèn)題IssueISS參考資料Refere neeREF4. 文檔標(biāo)識(shí)4.1帶版本文檔帶版本文檔指的是有版本修訂、演進(jìn)過(guò)程的文檔，項(xiàng)目中絕大部分管理文檔和技術(shù)文檔（第 三節(jié)的文檔清單中以黑色字體標(biāo)識(shí)）都是帶版本的。4.1.1標(biāo)識(shí)號(hào)（ID）文檔的標(biāo)識(shí)號(hào)用于命名文檔，同時(shí)寫入文檔的配置管理頁(yè)與頁(yè)眉中。帶版本文檔的標(biāo)識(shí)號(hào)形式為:項(xiàng)目/產(chǎn)品英文簡(jiǎn)稱-系統(tǒng)/子系統(tǒng)/組件代碼-文檔類別-文檔代碼其中:項(xiàng)目/產(chǎn)品英文簡(jiǎn)稱:項(xiàng)目/產(chǎn)品立項(xiàng)時(shí)確定的英文名稱縮寫，如OBS_1.0系統(tǒng)/子系統(tǒng)/組件代碼:系統(tǒng)/子系統(tǒng)/組件代碼用于標(biāo)識(shí)文檔的級(jí)別或其所屬的子

12、系統(tǒng)/組件。對(duì)于系統(tǒng)級(jí)文檔，該代碼為SYS;對(duì)于子系統(tǒng)/組件級(jí)文檔，該代碼為子系統(tǒng) /組件代碼。子系統(tǒng) /組件由項(xiàng)目經(jīng)理在總體設(shè)計(jì)完成之前確定，并寫入總體設(shè)計(jì)規(guī)格說(shuō)明書文檔類別 ：本文檔第二節(jié)確定的文檔類別 文檔代碼 ：本文檔第三節(jié)確定的文檔代碼（ 若有本文檔中未識(shí)別出來(lái)的文檔，請(qǐng)及時(shí)通知您的 SQA 工程師以獲得幫助 ），如果同類文檔有多個(gè)，可以在本節(jié)加上兩位數(shù)的編碼。樣例：OBS_1.0-SYS-MNG-SDS為 OBS 系統(tǒng) 1.0 版的軟件開發(fā)日程表OBS_1.0-SYS-DSN-MOD為系統(tǒng)設(shè)計(jì)模型OBS_1.0-JSP-DSN-DDS為 JSP 組件的詳細(xì)設(shè)計(jì)規(guī)格說(shuō)明書OBS_1.

13、0-JSP-TST-UTR為 JSP 組件的單元測(cè)試報(bào)告OBS_1.0-SYS-TST-ITD01為集成測(cè)試的第一組測(cè)試數(shù)據(jù)4.1.2 版本號(hào)版本號(hào)形式為x.y，其中y表示文檔修訂的次數(shù)，x表示文檔發(fā)布的次數(shù)。文檔初始版本號(hào)為 0.1，以后每產(chǎn)生一次修訂，y+1 第一次發(fā)布的正式版版本號(hào)為 1.0，以后每產(chǎn)生一次修訂， y+1 重新評(píng)審和發(fā)布， x+1SCM 報(bào)告、 SQA4.2 無(wú)版本文檔無(wú)版本文檔指的是由項(xiàng)目當(dāng)前狀態(tài)評(píng)估而產(chǎn)生的各種文檔，如評(píng)審報(bào)告、 報(bào)告等各種報(bào)告以及任務(wù)單、變更請(qǐng)求表等表單。在第三節(jié)的文檔清單中以灰色字體標(biāo)識(shí)。4.2.1 項(xiàng)目文檔項(xiàng)目中無(wú)版本文檔的標(biāo)識(shí)號(hào)形式為：項(xiàng)目/產(chǎn)

14、品英文簡(jiǎn)稱 -系統(tǒng)/子系統(tǒng)/組件代碼 -文檔類別 -文檔代碼 -日期/編碼其中：項(xiàng)目/產(chǎn)品英文簡(jiǎn)稱 ：項(xiàng)目 /產(chǎn)品立項(xiàng)時(shí)確定的英文名稱縮寫，如OBS_1.0系統(tǒng)/子系統(tǒng)/組件代碼：系統(tǒng)/子系統(tǒng)/組件代碼用于標(biāo)識(shí)文檔的級(jí)別或其所屬的子系統(tǒng)/組件。對(duì)于系統(tǒng)級(jí)文檔，該代碼為SYS;對(duì)于子系統(tǒng)/組件級(jí)文檔，該代碼為子系統(tǒng) /組件代碼。子系統(tǒng) /組件由項(xiàng)目經(jīng)理在總體設(shè)計(jì)完成之前確定，并寫入總體設(shè)計(jì)規(guī)格說(shuō)明書文檔類別 ：本文檔第二節(jié)確定的文檔類別文檔代碼 ：本文檔第三節(jié)確定的文檔代碼（若有本文檔中未識(shí)別出來(lái)的文檔，請(qǐng)及時(shí)通知您的 SQA 工程師以獲得幫助）日期/編碼：對(duì)于各種報(bào)告規(guī)定為報(bào)告的日期，形式為Y

15、YYYMMDD ；對(duì)于各種表單則為 3 位數(shù)的流水號(hào)樣例：OBS_1.0-SYS-REQ-RR-20011121為 2001 年 11 月 21 日需求評(píng)審的報(bào)告OBS_1.0-JSP-DSN-RR-20011121為2001年11月21日J(rèn)SP組件詳細(xì)設(shè)計(jì)評(píng)審的報(bào)告OBS_1.0-SYS-SQA-IR-20011123為 2001 年 11 月 23 日的 SQA 問(wèn)題報(bào)告OBS_1.0-SYS-SCM-CR-001為項(xiàng)目的第一個(gè)變更請(qǐng)求4.2.2 員工周報(bào)員工周報(bào)命名方式為：WR-NAME （ - 日期 ）其中：NAME ：公司統(tǒng)一的 Email 帳號(hào)日期：項(xiàng)目規(guī)定的報(bào)告日期，形式為YYYYMMDD樣例：WR-LIJUAN-200111215. 文檔格式文檔的格式包括：文檔封面 頁(yè)眉和頁(yè)腳 目錄（正文 1 0頁(yè)以上的文檔必須有目錄） 標(biāo)題與字體格式 配置管理頁(yè)（所有帶版