ASD_文档命名规范.doc

应用软件开发组 文档命名规则版本更新记录T-0版本更新记录版本号更新日期作者摘要V1.02008-10-30林 蓉整理出初稿V1.012009-02-04林 蓉添加feature ID命名规则V1.022009-02-08林 蓉经过正式评审，修改了技术文档命名规则V1.032009-02-16林 蓉删除阶段名称，并增加文件种类COM、QAT、QAWR、QARV1.042009-03-03林 蓉增加SOP、模板、检查单的命名规则V1.052009-03-27林 蓉修正模板、检查单的文件种类简称为SF、CLV1.062009-06-15林 蓉根据项目配置清单增加文件种类，并整理各阶段文档的命名示例V2.02009-07-06林 蓉对文档进行排版，增加架构设计阶段的相关文档示例，增加3D墙、棋牌网站、浏览器、阅读器等项目名称及编号命名，并更新示例附表内容V2.12009-08-21林 蓉新增产品规划组命名PP、市场推广命名MK、其他公共类文档命名COM,更新附录示例表V2.22010-1-13林 蓉整合单元测试工作的文档命名、去掉系统测试命名规范增加R，表示开发过程文档的关联文档命名规范V2.32010-3-01林 蓉取消用户手册、参考资料、版本更新履历命名规范，其中版本更新履历各项目统一采用项目中文名称+版本更新履历，用户手册统一采用项目中文名称+使用帮助，如91笔记版本更新履历、91笔记使用帮助目录文档命名规则11目的32使用范围33建立受控库和统一文件编号的目的34目录和文件命名规则34.1组名及项目名称表示34.2项目编号44.3日期表示44.4作者表示45开发过程类文档45.1Feature ID55.2文件种类55.3文件版本号65.4文档顺序号66其它类文档76.1会议纪要76.2个人周报76.3流程组文档77示例附表81 目的本指导书规范应用软件部文档配置资料和项目开发资料的存放路径和文件名创建规则。文档的存放路径结合文件名可作为该电子文档的唯一标识。2 使用范围本编号方法适用于应用软件部内部开发设计资料的编号。此编码规则目录等仅为一般规约，每个项目具体执行时可参照项目配置管理计划。3 建立受控库和统一文件编号的目的文档配置采用三级库管理的方式，即开发库01_Trunk、受控库02_Tages和产品库03_WorkArea。受控库定义为在软件生存周期的某一个阶段结束时，存放作为阶段产品而释放的、与软件开发工作有关的计算机可读和人工可读信息的文档和数据的集合。软件配置管理就是对软件受控库中的各个软件配置项进行管理，因此软件受控库也叫软件配置管理库。4 目录和文件命名规则开发库和受控库目录分以下几级/A/B/C/D./EA: 项目名，采用项目编号_项目名称，如04_NoteManager，尽量使用英文字母命名，不使用中文；B: 库名，开发库为01_Trunk，受控库的名称为02_Tages，产品库为03_WorkArea；C: 文档分类目录，如0_Common, 1_ProjPlan, 2_ProjMonitor, 3_CfgMan, 4_DevProcess, 5_QA，6_Training，99_RefDoc；开发库中的RefDoc目录存放开发中使用的参考资料，参考资料不限制具体命名和格式；D: 文档分类可细分为多个子目录， 4_DevProcess下有划分子目录0_ReqAna，1_ArcDesign，2_PreDesign，3_Src，4_Test，5_ProductIntge，6_UserManual，7_MaintenanceE: 文件名，参看表一的具体的文件命名规则(适用于开发库和受控库)；4.1 组名及项目名称表示要求项目名称不能太长，采用91+项目缩写，首字母大写本小组全称：程序应用软件开发组简称：ASD(Application Software Development)项目简称： Common 代表共通项目 91 English 代表英语学习项目 91 Money 代表个人理财项目 91 Note 代表笔记管理项目 91 See 代表图像管理项目 91Divine 代表算命项目 91Reader 代表阅读器项目91Browser代表浏览器项目3DPIC 代表3D墙项目91UAP 代表棋牌网站91U 代表91U项目91BBSReader 代表91坛子项目91NetbarSoft 代表网吧项目 4.2 项目编号项目编号具有唯一性，按两位数字编号，从00开始编，如：00 代表共通项目01 代表英语项目02 代表个人理财项目03 代表坛子项目04 代表笔记管理项目05 代表图像管理项目06 代表算命软件项目09 代表浏览器项目10 代表阅读器项目11 代表HER项目13 代表91U项目14 代表棋牌网站项目17 代表3D墙项目有些项目，可再细分成各个子项目，子项目编号从01、02.开始,如01内存检查工具02程序错误汇报03CS通信06日志类07代码注释工具0991账户认证10在线更新升级12安装盘的制作19文件数据库评测25BCG使用共通26加解密和校验库34软件的手机版捆绑功能4.3 日期表示格式： yyyymmddyyyy:用四位数字表示公元年份，如2005表示公元2005年。mm:用两位数字表示月份，不足两位时，第一位用零补齐，如03表示3月。dd: 用两位数字表示日期，不足两位时，第一位用零补齐，如15表示第15号。 例如： 20031027 表示（2003年10月27日）4.4 作者表示采用SVN上的用户名，即拼音缩写，取姓全拼名首字母,如：wangxq、linrong5 开发过程类文档这里只统一开发过程文档的命名（源代码部分遵循公司的“编码规范”），开发类文档命名规范： _Future ID_R（中文注释）备注：下划连线“_”用来分开各名称域R全称Relating,表示关联文档，若某一文档存在关联文档，则关联文档命名需用R标识，以作区别，如：91Note_A01_01_PDD_V1.0_R(A01阶段01概要设计关联文档)示例：91Note_A01_PDP_V1.0(A01阶段开发计划) 91Note_A01_01_PDP_V1.0(A01阶段01*开发计划) 91Note_PDP_V1.0(开发计划)91Note_FP_V1.0(feature计划明细表)91Note_A01_01_PDD_V1.0(A01阶段01概要设计文档)91Note_A01_01_PDD_V1.0_R(A01阶段01概要设计关联文档)5.1 Feature ID_ 开发阶段：采用英文字母+两位数字编号，英文字母从AZ算起，两位数字从01开始编号，备注：开发阶段的命名规范仅供参考，部分项目可根据实际情况对开发阶段进行命名约定 主功能ID：采用两位数字编号，从01开始算起，01，02. 子功能ID：采用三位数字编号，从001开始算起，01，02.示例： A01_01_0015.2 文件种类采用相应工作过程名称的简称（例如 PDP，ADD），应该遵守下面表格中的标准。文件种类简称项目开发计划文件 (Project Development Plan )PDP测试计划 (Test Plan)TP质量保证计划 (Quality Assurance Plan)QAP配置管理计划 (Configuration Management Plan）CMPPC_LINT检查表PCLINT项目进度情况表(Project Progress Status)PPS项目总结报告 (Project Final Report)PFR配置项清单 （Conficuguration Item List）CIL软件功能需求列表 (Softeare Function Requirement List)SFR需求分析文档 (Requirements Analysis Document)需求分析检查表 (Requirements Analysis Checklist)需求分析评审报告(Requirements Analysis Review)RADRACLRAR架构设计文档 (Architecture Design Document)架构设计检查表 (Architecture Design Checklist)架构设计评审报告(Architecture Design Review)ADDADCLADR数据库设计 (DataBase Design)数据库设计检查表（DataBase Review Checklist）DBDDBCL概要设计文档 (Preview Design Document)概要设计检查表 (Preview Design Checklist)概要设计评审报告(Preview Design Review)编码评审规则(Code Review Rules)代码评审报告（Code Review） PDDPDCLPDRCRRCR单元测试清单及结果 (Cent Test List)功能测试清单及结果 (Function Test List)功能测试清单评审报告 (Function Test Review)集成测试（Integration Test List）集成测试清单评审报告 (Integration Test Review)CTLFTLFTRITLITR测试进度报告 (Test Progress Report）TPR个人周报(Personal Weekly)PW问题列表 (Problem List)PL项目组周报(Group Weekly)GW质量保证报告(Quality Assurance Report)QARQA评审表(Quality Assurance Table)QATQA工作评审表(Quality Assurance Working Review)QAWR用户手册 (User Manual)UM参考资料 （Reference Document）新版本发行通知(Version Release Notice)版本更新履历安装程序（Setup）版本发布检查表(Version Release Checkelist)小组人员体制表（Group Personel System）RDVRNHistorySetupVRCLGPS会议纪要Meeting其他公共类（即非开发过程类文档）Common市场推广(Marketing)COMMKFeature 明细及计划表（Feature Plan）FPSOP文档(Standard Operating Process)SOP模板文档SF检查单(Checklist)可行性研究报告（feasibility study report ）测试报告(Test Report)CLFSRTR5.3 文档版本号下面是对文件版本进行编号要遵守的标准：x.y(版本号.修改号) 起草版本的编号为 0.1, 0.2, 0.3, ., 0.10。一旦文档版本得以确认后，版本编号应该始自 1.0。版本编号不断变化为： 1.0, 1.1, 1.2, ., 1.10。 备注：文件有修改则修改号加一，若文档有升级，则版本号加一最后，（ ）内要求对文档做简要的中文注释，（）为英文半角状态下备注： 表此字段是可选的，如果有存在该字段，则按相应的字段规则命名，如果没有的话，则跳过6 其它类文档6.1 会议纪要指应用软件组内部会议的记录等。命名方式：_（中文注释）如：91Note_Meeting_20080901（笔记组周例会会议纪要）.docASD_Meeting_20081212(应用软件开发组早会会议纪要).doc91Note_Meeting_20080901（笔记组概设文档评审会）.doc注：由于会议纪要涉及到开会日期，所以独立出来命名，较直观6.2 个人周报命名方式：_（中文注释）如：91See_PW_xiaoh_20080808(肖宏个人周报).xls注：由于个人周报涉及到各开发人员，所以独立处理命名6.3 流程组文档命名方式：_版本号(中文注释）l 文件种类: SOP:指导书 SF:模板 CL：Checklist检查单l 流程组名产品规划组 PP示例：SOP_AD_V1.0(架构设计的工具指南和说明)SF_DB_V1.0(数据库设计模板)CL_DB_V1.0(数据库评审检查表)SF_OT_V1.0(会议纪要模板)7 示例附表Table 1. 文件命名规则文档目录文档分类文件命名规则文件内容服务器名称：项目名称 01_Trunk开发库0_Common会议纪要_（中文注释）例: 91Note_Meeting_20080901（笔记组周例会会议纪要）.docASD_Meeting_20080901（应软组早会会议纪要）.doc会议纪要服务器名称：项目名称 01_Trunk开发库1_ProjPlan1_项目计划开发计划_Future ID_VX.Y（中文注释）例：91Note_A01_PDP_V1.0(项目开发计划).doc 91Note_A01_01_PDP_V1.0(A01阶段01功能开发计划).doc91Note_A01_01_001_PDP_V1.0(A01阶段001功能开发计划).doc 91Note_QAP_V1.0(质量保证计划).doc91Note_CMP_V1.0(配置管理计划).doc91Note_TP_V1.0(测试计划).doc开发计划，包含项目开发计划，质量保证计划，配置管理计划，测试计划等备注：Future ID里头的相应字段（_）为可选字段，请根据实际情况选择服务器名称：项目名称 01_Trunk开发库2_ProjMonitor0_Week Report1_ProLeader服务器名称：项目名称 01_Trunk开发库2_ProjMonitor0_Week Report2_ProDev项目周报个人周报_（中文注释）例： 91Note_GW_20090205(笔记项目周报).xls _（中文注释） 91Note_PW_linrong_20090205(个人周报).xls周报，个人周报和项目周报命名格式有些不一样，且存放路径也不同服务器名称：项目名称 01_Trunk开发库4_DevProcess0_ReqAna0_Document需求分析_Future ID_VX.Y（中文注释）例：91Note_FP_VX.Y(Feature明细及计划)91Note_A01_RAD_VX.Y(A01阶段需求分析说明书)91Note_A01_01_RAD_VX.Y(01功能需求分析说明书)需求分析文档，FID明细表里包含软件功能原始需求列表，版本发布计划,待办单，风险管理表、产品创新统计、下单计算表等备注：VX.Y为文档版本号服务器名称：项目名称 01_Trunk开发库4_DevProcess0_ReqAna0_Document1_Review需求分析阶段核查报告_Future ID_（中文注释）例：91Note_A01_01_RAR_yyyymmdd (01功能需求分析评审报告).xls91Note_A01_RAR_yyyymmdd (A01阶段需求分析评审报告).xls核查(review)报告服务器名称：项目名称 01_Trunk开发库4_DevProcess 1_ArcDesign 0_Document架构设计_Future ID_VX.Y（中文注释）例：91Note_A01_ADD_VX.Y(A01阶段架构设计文档) 91Note_ADD_VX.Y(架构设计文档)架构设计服务器名称：项目名称 01_Trunk开发库4_DevProcess 1_ArcDesign 1_Review架构设计阶段核查报告_Future ID_（中文注释）例：91Note_A01_ADR_yyyymmdd (A01阶段架构设计文档核查报告).xls91Note_ADR_yyyymmdd (架构设计文档核查报告).xls核查(review)报告服务器名称：项目名称 01_Trunk开发库4_DevProcess 8_DataBaseDesign 0_Document数据库设计_Future ID_VX.Y（中文注释）例：91Note_A01_DBD_VX.Y(A01阶段数据库设计文档)91Note_ DBD_VX.Y(数据库设计文档)数据库设计服务器名称：项目名称 01_Trunk开发库4_DevProcess 8_DataBaseDesign 1_Review数据库设计阶段核查报告_Future ID_（中文注释）例：91Note_A01_DBR_yyyymmdd (A01阶段架构设计文档核查报告).xls91Note_DBR_yyyymmdd (架构设计文档核查报告).xls核查(review)报告服务器名称：项目名称 01_Trunk开发库4_DevProcess 2_PreDesign 0_Document概要设计_Future ID_VX.Y中文注释）例：91Note_A01_01_34_PDD_VX.Y(34子功能概要设计文档)91Note_A01_01_PDD_VX.Y(01功能概要设计文档)91Note_A01_PDD_VX.Y(A01阶段概要设计文档)概要设计服务器名称：项目名称 01_Trunk开发库4_DevProcess 2_PreDesign 1_Review概要设计核查报告_Future ID_（中文注释）例：91Note_A01_01_34_PDR_yyyymmdd(34子功能概要设计文档核查报告).xls91Note_A01_01_PDR_yyyymmdd(01功能概要设计文档核查报告).xls核查(review)报告服务器名称：项目名称 01_Trunk开发库4_DevProcess 3_Src1_Review代码核查报告_Future ID_（中文注释）例：91Note_A01_01_34_CR_yyyymmdd (*代码核查报告).xls服务器名称：项目名称 01_Trunk开发库4_DevProcess 3_Src5_CT单元测试_Future ID_ (中文注释）例： 91Note_A01_CTL_V1.0（单元测试清单）_Future ID_ _ (中文注释）例：91English_A01_01_CTR_20080504（*模块单元测试清单评审报告）91English_A01_01_001_CTR_20080504（单元测试清单评审报告）PS:单元测试目录按时间来创建单元测试包含PCLINT+GTEST(C+语言使用)，可搭建每日构建平台，DELPHI或PHP开发语言的单元测试工作，可根据实际情况考虑采用何种方法。备注：单元测试评审报告放在Review目录下服务器名称：项目名称 01_Trunk开发库4_DevProcess 4_Test0_测试清单服务器名称：项目名称 01_Trunk开发库4_DevProcess 4_Test 4_Review服务器名称：项目名称 01_Trunk开发库4_DevProcess 4_Test 5_ProblemList测试清单文档测试清单评审报告问题列表_Future ID_ (中文注释）例：91Note_A01_01_34_FTL_V1.0（功能测试清单）91English_A01_01_34_FTCL_V1.0（功能测试清单检查表）91Note_A01_ITL_V1.0（集成统测试清单）91English_A01_ITCL_V1.0（集成测试清单检查表）_Future ID_ _ (中文注释）91English_A01_01_34_FTR_20090528（功能测试清单评审报告）91English_A01_01_34_ITR_20090525（集成测试清单评审报告）_Future ID_ (中文注释）91English_ PL_V0.3.0beta（0.3.0内测版问题列表）备注：软件版本提交给测试组之前，开发组内部需进行简单的功能测试工作，集成测试为测试组的功能测试输出文档,问题列表为测试组工作服务器名称：项目名称 01_Trunk开发库 5_QA_Future ID_(中文注释）例：91Note_QAR_V0.1.3(质量保证报告)91Note_QAT_V0.1.3(QA评审表)91Note_QAWR_V0.1.3(QA工作评审表)备注：VX.Y.Z代表QA工作检查的软件发布版本号服务器名称：项目名称 01_Trunk开发库4_DevProcess 3_Src 5_Prod