《科技公司文档控制规范.doc》由会员分享，可在线阅读，更多相关《科技公司文档控制规范.doc（12页珍藏版）》请在三一办公上搜索。
1、文档管理规范文档管理规范版本版本 2.2配置管理配置管理文档类别：耀邦软件规范文档名称：文档管理规范文档标识：ybsw-doc版本：2.2状态：草稿访问路径：ybsw_vobtech模板：ybsw-tmpl-word.dot v1.0所有人：SEPG作者/创建时间：2005-11-28批准人/批准时间：修订历史：日期版本说明作者2005-11-121.01、 列出已识别的文档清单及其代码2、 定义文档的标识规则3、 给出一般文档的格式规范2005-11-191.11、 重新细化分类所有文档（对命名方式无影响）2、 添加周报命名方式3、 添加红色字体的注释信息2005-11-211.21、 取消
2、文件名中的版本号2、 增加“任务单” 、 “业务分析规格说明书”和“系统部署文档”的标识3、 文件名中添加“文档类别”项4、 增加无版本文档的标识规范5、 增加文档命名的样例2005-11-221.31、 增加对文档修订的规定2、 用蓝色字体标识本次修改的部分2005-11-231.4修订版本号标识规则2005-11-232.0正式发布 2.0 版2005-11-262.1修订一处微小错误2005-11-282.21、 修改 SCM 审计报告的代码2、 增加“参考编码规则”3、 改“变更请求”为“变更申请”目录目录1.简介简介.51.1目的.51.2范围.51.3读者.52.文档类别文档类别.
3、53.文档清单文档清单.54.文档标识文档标识.84.1带版本文档.84.1.1标识号（ID）.84.1.2版本号.94.2无版本文档.94.2.1项目文档.94.2.2员工周报.105.文档格式文档格式.106.文档修订文档修订.11文档管理文档管理1. 简介简介1.1 目的目的编制本文档的目的在于为所有的项目文档的命名、编码以及版本号的确定建立一套统一的规则和方法，以唯一地确定项目的每一产出物。1.2 范围范围本文档仅描述项目级文档的管理规则，不包括公司级文档。1.3 读者读者所有软件工程人员应该阅读本文档，并遵从本文档的规则识别项目中产生的文档，并对其进行标识以及按照规范的格式撰写文档。
4、2. 文档类别文档类别类别说明代码管理类各种有关项目策划、度量、跟踪、调整的文档MNG需求类各种与业务和需求相关的文档、模型REQ设计类各种设计文档、模型等DSN实施类与软件开发和集成相关的文档IMP测试类测试相关文档、数据等TST发布类发布声明以及各种用户文档RELSCM 类SCM 系统相关文档及 SCM 报告SCMSQA 类SQA 计划及报告SQA参考资料类各种参考资料REF3. 文档清单文档清单序号文档中文名称文档英文名称文档代码模板评审级别管理类（MNG）1立项申请Project Establish RequestPER/组织级2项目任务书Statement of WorkSOW/组织
5、级3软件开发计划Software Development PlanSDPybsw-tmpl-mng-sdp.dot组织级4软件开发日程表Software Development ScheduleSDS/组织级5软件维护计划Software Maintainance PlanSMP/组织级6任务单Task FormTASK/7项目度量报告Project Measurement ReportPMR/8项目跟踪报告Project Tracking ReportPTR/9项目总结报告Project Summary ReportPSR/组织级需求类（REQ）1可行性分析报告Feasibility Ana
6、lysis ReportFAR/组织级2业务分析规格说明书Business Analysis SpecificationBAS/组织级3前景与范围Vision and ScopeVNS/组织级4软件需求规格说明书Software Requirment SpecificationSRSybsw-tmpl-req srs.dot组织级设计类（DSN）1总体设计说明书General Design SpecificationGDS/项目级2数据库设计说明书Database Design SpecificationDBDS/项目级3用户界面设计说明书User Interface Design Speci
7、ficationUIDS/项目级4接口设计说明书Interface Design SpecificationIDS/项目级5详细设计说明书Detailed Design SpecificationDDS/项目级实施类（IMP）1软件配置清单Software Configuration ListSCL/项目级2软件开发文件Software Development FileSDF/项目级3系统部署文档System Deployment DocumentSDD/项目级测试类（TST）1单元测试用例Unit Test CaseUTC/2单元测试数据Unit Test DataUTD/3单元测试脚本Un
8、it Test ScriptUTS/4单元测试报告Unit Test ReportUTR/项目级5集成测试用例Integration Test CaseITC/6集成测试数据Integration Test DataITD/7集成测试脚本Integration Test ScriptITS/8集成测试报告Integration Test ReportITR/项目级9系统测试用例System Test CaseSTC/10系统测试数据System Test DataSTD/11系统测试脚本System Test ScriptSTS/12系统测试报告System Test ReportSTR/组织
9、级发布类（REL）1产品技术白皮书Product Technical WhitepaperPTW/组织级2系统安装手册System Installation ManualSIM/组织级3用户操作手册User Operation ManualUOM/组织级4产品维护手册Product Maintainance ManualPMM/组织级5产品培训资料Product Training MaterialsPTM/组织级6产品发布声明Product Release NotePRN/组织级SCM 类（SCM）1建库申请表 System Request FormRFybsw-tmpl-scm-srf.do
10、t 项目级2建库验证报告System Verify ReportVR/3SCM 审计报告SCM Audit ReportAR/4变更申请表Change RequestCR/项目级SQA 类（SQA）1SQA 报告SQA ReportRPT/2SQA 问题报告Issue ReportIR/其它1评审报告Review ReportRRybsw-tmpl-rr.dot/2员工周报Weekly ReportWRybsw-tmpl-wr.xls/对于以上文档清单中未列出的文档，可参考以下编码规则以确定其代码：参考编码规则中文名称英文名称代码中文名称英文名称代码计划PlanPLN样例SampleSMPL模
11、型ModelMDL文档DocumentDOC数据DataDATA工具ToolTOOL脚本ScriptSCRP报告ReportRPT问题IssueISS参考资料ReferenceREF4. 文档标识文档标识4.1 带版本文档带版本文档带版本文档指的是有版本修订、演进过程的文档，项目中绝大部分管理文档和技术文档（第三节的文档清单中以黑色字体标识）都是带版本的。4.1.1 标识号（标识号（ID）文档的标识号用于命名文档，同时写入文档的配置管理页与页眉中。带版本文档的标识号形式为：项目/产品英文简称-系统/子系统/组件代码-文档类别-文档代码其中：项目/产品英文简称：项目/产品立项时确定的英文名称缩写
12、，如 OBS_1.0系统/子系统/组件代码：系统/子系统/组件代码用于标识文档的级别或其所属的子系统/组件。对于系统级文档，该代码为 SYS；对于子系统/组件级文档，该代码为子系统/组件代码。子系统/组件由项目经理在总体设计完成之前确定，并写入总体设计规格说明书文档类别：本文档第二节确定的文档类别文档代码：本文档第三节确定的文档代码（若有本文档中未识别出来的文档，请及时通知您的 SQA 工程师以获得帮助），如果同类文档有多个，可以在本节加上两位数的编码。样例：OBS_1.0-SYS-MNG-SDS为 OBS 系统 1.0 版的软件开发日程表OBS_1.0-SYS-DSN-MOD为系统设计模型O
13、BS_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 表示文档发布的次数。文档初始版本号为 0.1，以后每产生一次修订，y+1第一次发布的正式版版本号为 1.0，以后每产生一次修订，y+1重新评审和发布，x+14.2 无版本文档无版本文档无版本文档指的是由项目当前状态评估而产生的各种文档，如评审报告、SCM 报告、SQA 报告等各种报告以及任务单、变更请求表等表单
14、。在第三节的文档清单中以灰色字体标识。4.2.1 项目文档项目文档项目中无版本文档的标识号形式为：项目/产品英文简称-系统/子系统/组件代码-文档类别-文档代码-日期/编码其中：项目/产品英文简称：项目/产品立项时确定的英文名称缩写，如 OBS_1.0系统/子系统/组件代码：系统/子系统/组件代码用于标识文档的级别或其所属的子系统/组件。对于系统级文档，该代码为 SYS；对于子系统/组件级文档，该代码为子系统/组件代码。子系统/组件由项目经理在总体设计完成之前确定，并写入总体设计规格说明书文档类别：本文档第二节确定的文档类别文档代码：本文档第三节确定的文档代码（若有本文档中未识别出来的文档，请
15、及时通知您的 SQA 工程师以获得帮助）日期/编码：对于各种报告规定为报告的日期，形式为 YYYYMMDD；对于各种表单则为 3 位数的流水号样例：OBS_1.0-SYS-REQ-RR-为 2001 年 11 月 21 日需求评审的报告OBS_1.0-JSP-DSN-RR-为 2001 年 11 月 21 日 JSP 组件详细设计评审的报告OBS_1.0-SYS-SQA-IR-为 2001 年 11 月 23 日的 SQA 问题报告OBS_1.0-SYS-SCM-CR-001为项目的第一个变更请求4.2.2 员工周报员工周报员工周报命名方式为：WR-NAME（-日期）其中：NAME：公司统一的
16、 Email 帐号日期：项目规定的报告日期，形式为 YYYYMMDD样例：WR-LIJUAN-5. 文档格式文档格式文档的格式包括：文档封面页眉和页脚目录（正文 10 页以上的文档必须有目录）标题与字体格式配置管理页（所有带版本的文档必须有配置管理页）评审记录（需要评审的文档应附评审及批准的记录）无特殊情况文档均采用 Microsoft Word 2000 进行编辑，整体格式见 Word 文档模板 ybsw-tmpl-word.dot。6. 文档修订文档修订每次修订文档应填写配置管理页中的“修订历史”。每次修订的内容应以蓝色字体标识。评审记录评审记录评审要求：本文档需要组织级评审，参加评审的人包括 SEPG 以及主管技术的高级经理。必须由SEPG 组长、质量经理和高级经理共同签字批准才能生效。批准人：姓名职务签名时间
