研发文档管理规范

文档管理规范v1.0密级：秘密2012-6-12第1页共9页文档管理规范版本1.0修订记录初稿日期2012-6-15修正日期审核日期批准日期深圳恒飞盈通科技有限公司版权所有侵权必究文档管理规范v1.0密级：秘密2012-6-12第2页共9页目录1.简介........................................................................................................................................................31.1目的................................................................................................................................................31.2范围................................................................................................................................................31.3读者................................................................................................................................................32.文档类别................................................................................................................................................33.文档清单................................................................................................................................................34.文档标识................................................................................................................................................64.1带版本文档....................................................................................................................................64.1.1标识号（ID）........................................................................................................................64.1.2版本号....................................................................................................................................74.2无版本文档....................................................................................................................................74.2.1项目文档................................................................................................................................74.2.2员工周报................................................................................................................................85.文档格式................................................................................................................................................96.文档修订................................................................................................................................................9文档管理规范v1.0密级：秘密2012-6-12第3页共9页文档管理1.简介1.1目的编制本文档的目的在于为所有的项目文档的命名、编码以及版本号的确定建立一套统一的规则和方法，以唯一地确定项目的每一产出物。1.2范围本文档仅描述项目级文档的管理规则，不包括公司级文档。1.3读者所有软件工程人员应该阅读本文档，并遵从本文档的规则识别项目中产生的文档，并对其进行标识以及按照规范的格式撰写文档。2.文档类别类别说明代码管理类各种有关项目策划、度量、跟踪、调整的文档MNG需求类各种与业务和需求相关的文档、模型REQ设计类各种设计文档、模型等DSN实施类与软件开发和集成相关的文档IMP测试类测试相关文档、数据等TST发布类发布声明以及各种用户文档REL参考资料类各种参考资料REF3.文档清单序号文档中文名称文档英文名称文档代码模板评审级别文档管理规范v1.0密级：秘密2012-6-12第4页共9页管理类（MNG）1立项申请ProjectEstablishRequestPER/组织级2项目任务书StatementofWorkSOW/组织级3软件开发计划SoftwareDevelopmentPlanSDP/组织级4软件开发日程表SoftwareDevelopmentScheduleSDS/组织级5软件维护计划SoftwareMaintainancePlanSMP/组织级6任务单TaskFormTASK//7项目跟踪报告ProjectTrackingReportPTR//8项目总结报告ProjectSummaryReportPSR/组织级需求类（REQ）1可行性分析报告FeasibilityAnalysisReportFAR/组织级2业务分析规格说明书BusinessAnalysisSpecificationBAS/组织级3前景与范围VisionandScopeVNS/组织级4软件需求规格说明书SoftwareRequirmentSpecificationSRS/组织级设计类（DSN）1总体设计说明书GeneralDesignSpecificationGDS/项目级2数据库设计说明书DatabaseDesignSpecificationDBDS/项目级3用户界面设计说明书UserInterfaceDesignSpecificationUIDS/项目级4接口设计说明书InterfaceDesignSpecificationIDS/项目级文档管理规范v1.0密级：秘密2012-6-12第5页共9页5详细设计说明书DetailedDesignSpecificationDDS/项目级实施类（IMP）1软件配置清单SoftwareConfigurationListSCL/项目级2软件开发文件SoftwareDevelopmentFileSDF/项目级3系统部署文档SystemDeploymentDocumentSDD/项目级测试类（TST）1单元测试用例UnitTestCaseUTC//2单元测试数据UnitTestDataUTD//3单元测试脚本UnitTestScriptUTS//4单元测试报告UnitTestReportUTR/项目级5集成测试用例IntegrationTestCaseITC//6集成测试数据IntegrationTestDataITD//7集成测试脚本IntegrationTestScriptITS//8集成测试报告IntegrationTestReportITR/项目级9系统测试用例SystemTestCaseSTC//10系统测试数据SystemTestDataSTD//11系统测试脚本SystemTestScriptSTS//12系统测试报告SystemTestReportSTR/组织级发布类（REL）1产品技术白皮书ProductTechnicalWhitepaperPTW/组织级2系统安装手册SystemInstallationManualSIM/组织级3用户操作手册UserOperationManualUOM/组织级4产品维护手册ProductMaintainanceManualPMM/组织级文档管理规范v1.0密级：秘密2012-6-12第6页共9页5产品培训资料ProductTrainingMaterialsPTM/组织级6产品发布声明ProductReleaseNotePRN/组织级其它1评审报告ReviewReportRR//2员工周报WeeklyReportWR//对于以上文档清单中未列出的文档，可参考以下编码规则以确定其代码：参考编码规则中文名称英文名称代码中文名称英文名称代码计划PlanPLN样例SampleSMPL模型ModelMDL文档DocumentDOC数据DataDATA工具ToolTOOL脚本ScriptSCRP报告ReportRPT问题IssueISS参考资料ReferenceREF4.文档标识4.1带版本文档带版本文档指的是有版本修订、演进过程的文档，项目中绝大部分管理文档和技术文档（第三节的文档清单中以黑色字体标识）都是带版本的。4.1.1标识号（ID）文档的标识号用于命名文档，同时写入文档的配置管理页与页眉中。带版本文档的标识号形式为：[项目/产品英文简称]-[系统/子系统/组件代码]-[文档类别]-[文档代码]其中：[项目/产品英文简称]：项目/产品立项时确定的英文名称缩写，如OBS_1.0[系统/子系统/组件代码]：系统/子系统/组件代码用于标识文档的级别或其所属的子系统/组件。对于系统级文档，该代码为SYS；对于子系统/组件级文档，该代码为子系统/组件代码。子系统/组件由项目经理在总体设计完成之前确定，并写入总体设计规格说明书文档管理规范v1.0密级：秘密2012-6-12第7页共9页[文档类别]：本文档第二节确定的文档类别[文档代码]：本文档第三节确定的文档代码，如果同类文档有多个，可以在本节加上两位数的编码。样例：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为集成测试的第一组测试数据4.1.2版本号版本号形式为x.y，其中y表示文档修订的次数，x表