最全研发文档管理规范完整版文档格式.doc

1、5.文档格式96.文档修订9文档管理1. 简介1.1 目的编制本文档的目的在于为所有的项目文档的命名、编码以及版本号的确定建立一套统一的规则和方法，以唯一地确定项目的每一产出物。1.2 范围本文档仅描述项目级文档的管理规则，不包括公司级文档。1.3 读者所有软件工程人员应该阅读本文档，并遵从本文档的规则识别项目中产生的文档，并对其进行标识以及按照规范的格式撰写文档。2. 文档类别类别说明代码管理类各种有关项目策划、度量、跟踪、调整的文档MNG需求类各种与业务和需求相关的文档、模型REQ设计类各种设计文档、模型等DSN实施类与软件开发和集成相关的文档IMP测试类测试相关文档、数据等TST发布类发

2、布声明以及各种用户文档REL参考资料类各种参考资料REF3. 文档清单序号文档中文名称文档英文名称文档代码模板评审级别管理类（MNG）1立项申请Project Establish RequestPER/组织级2项目任务书Statement of WorkSOW3软件开发计划Software Development PlanSDP4软件开发日程表Software Development ScheduleSDS5软件维护计划Software Maintainance PlanSMP6任务单Task FormTASK7项目跟踪报告Project Tracking ReportPTR8项目总结报告Pr

3、oject Summary ReportPSR需求类（REQ）可行性分析报告Feasibility Analysis ReportFAR业务分析规格说明书Business Analysis SpecificationBAS前景与范围Vision and ScopeVNS软件需求规格说明书Software Requirment SpecificationSRS设计类（DSN）总体设计说明书General Design SpecificationGDS项目级数据库设计说明书Database Design SpecificationDBDS用户界面设计说明书User Interface Design

4、 SpecificationUIDS接口设计说明书Interface Design SpecificationIDS详细设计说明书Detailed Design SpecificationDDS实施类（IMP）软件配置清单Software Configuration ListSCL软件开发文件Software Development FileSDF系统部署文档System Deployment DocumentSDD测试类（TST）单元测试用例Unit Test CaseUTC单元测试数据Unit Test DataUTD单元测试脚本Unit Test ScriptUTS单元测试报告Unit

5、Test ReportUTR集成测试用例Integration Test CaseITC集成测试数据Integration Test DataITD集成测试脚本Integration Test ScriptITS集成测试报告Integration Test ReportITR9系统测试用例System Test CaseSTC10系统测试数据System Test DataSTD11系统测试脚本System Test ScriptSTS12系统测试报告System Test ReportSTR发布类（REL）产品技术白皮书Product Technical WhitepaperPTW系统安装手

6、册System Installation ManualSIM用户操作手册User Operation ManualUOM产品维护手册Product Maintainance ManualPMM产品培训资料Product Training MaterialsPTM产品发布声明Product Release NotePRN其它评审报告Review ReportRR员工周报Weekly ReportWR对于以上文档清单中未列出的文档，可参考以下编码规则以确定其代码：参考编码规则中文名称英文名称计划PlanPLN样例SampleSMPL模型ModelMDL文档DocumentDOC数据DataDATA

7、工具ToolTOOL脚本ScriptSCRP报告ReportRPT问题IssueISS参考资料Reference4. 文档标识4.1 带版本文档带版本文档指的是有版本修订、演进过程的文档，项目中绝大部分管理文档和技术文档（第三节的文档清单中以黑色字体标识）都是带版本的。4.1.1 标识号（ID）文档的标识号用于命名文档，同时写入文档的配置管理页与页眉中。带版本文档的标识号形式为：项目/产品英文简称-系统/子系统/组件代码-文档类别-文档代码其中：项目/产品英文简称：项目/产品立项时确定的英文名称缩写，如OBS_1.0系统/子系统/组件代码：系统/子系统/组件代码用于标识文档的级别或其所属的子系

8、统/组件。对于系统级文档，该代码为SYS；对于子系统/组件级文档，该代码为子系统/组件代码。子系统/组件由项目经理在总体设计完成之前确定，并写入总体设计规格说明书文档类别：本文档第二节确定的文档类别文档代码：本文档第三节确定的文档代码，如果同类文档有多个，可以在本节加上两位数的编码。样例：OBS_1.0-SYS-MNG-SDS为OBS系统1.0版的软件开发日程表OBS_1.0-SYS-DSN-MOD为系统设计模型OBS_1.0-JSP-DSN-DDS为JSP组件的详细设计规格说明书OBS_1.0-JSP-TST-UTR为JSP组件的单元测试报告OBS_1.0-SYS-TST-ITD01为集成测

9、试的第一组测试数据4.1.2 版本号版本号形式为x.y，其中y表示文档修订的次数，x表示文档发布的次数。文档初始版本号为0.1，以后每产生一次修订，y+1第一次发布的正式版版本号为1.0，以后每产生一次修订，y+1重新评审和发布，x+14.2 无版本文档无版本文档指的是由项目当前状态评估而产生的各种文档，如评审报告、SCM报告、SQA报告等各种报告以及任务单、变更请求表等表单。在第三节的文档清单中以灰色字体标识。4.2.1 项目文档项目中无版本文档的标识号形式为：项目/产品英文简称-系统/子系统/组件代码-文档类别-文档代码-日期/编码本文档第三节确定的文档代码（若有本文档中未识别出来的文档，

10、请及时通知您的SQA工程师以获得帮助）日期/编码：对于各种报告规定为报告的日期，形式为YYYYMMDD；对于各种表单则为3位数的流水号OBS_1.0-SYS-REQ-RR-20011121为2001年11月21日需求评审的报告OBS_1.0-JSP-DSN-RR-20011121为2001年11月21日JSP组件详细设计评审的报告OBS_1.0-SYS-SCM-CR-001为项目的第一个变更请求4.2.2 员工周报员工周报命名方式为：WR-NAME（-日期）NAME：公司统一的Email帐号日期：项目规定的报告日期，形式为YYYYMMDDWR-LIJUAN-200111215. 文档格式文档的格式包括： 文档封面 页眉和页脚 目录（正文10页以上的文档必须有目录） 标题与字体格式 配置管理页（所有带版本的文档必须有配置管理页） 评审记录（需要评审的文档应附评审及批准的记录）无特殊情况文档均采用Microsoft Word 2007进行编辑。6. 文档修订每次修订文档应填写配置管理页中的“修订历史”。每次修订的内容应以蓝色字体标识。评审记录评审要求：本文档需要组织级评审，参加评审的人包括SEPG以及主管技术的高级经理。必须由SEPG组长、质量经理和高级经理共同签字批准才能生效。批准人：姓名职务签名时间