YZ 国家邮政局标准化指导性文件 YZ/Z 0032—2001 邮政综合计算机网 应用系统开发文档规范 Application Development Documents Specification in Integrated Postal Services Networking 2001-08-27发布 国家邮政局发布 YZ/Z0032—2001 目 次 前言 III 范围 1 2引用标准 3文档种类 4文档结构和编写格式 5文档正文的编制要求 4 6文档提交方式 5 附录A(指导性文件的附录）开发计划 6 附录B(指导性文件的附录）需求说明书.. 8 附录C(指导性文件的附录）概要设计说明书.. 10 附录D(指导性文件的附录）详细设计说明书 13 附录E(指导性文件的附录）模块开发卷宗 15 附录F(指导性文件的附录）测试计划 17 附录G(指导性文件的附录）测试说明书. 19 附录H(指导性文件的附录）测试分析报告 20 附录J（指导性文件的附录）用户操作手册· 21 附录K(指导性文件的附录）安装手册 23 附录L(指导性文件的附录）运行维护手册· 24 附录M（指导性文件的附录）开发进度报告 26 附录N(指导性文件的附录)开发总结报告· 27 附录P(提示的附录）开发文档封面 29 附录Q(提示的附录）表格样式 30 YZIZ0032—2001 前 本指导性文件是为编制邮政综合计算机网应用系统软件开发文档而制定的，对应用系统开发的软 件文档种类、内容和编写格式，制定了基本的要求。 邮政综合计算机网的应用软件开发应遵循软件工程的相关标准和规范。本指导性文件是软件开发 方在进行各应用系统的建设时，编制和提交软件开发文档的主要依据。 本指导性文件主要依据《计算机软件工程规范国家标准汇编2000》而制定。 本指导性文件的附录A、附录B、附录C、附录D、附录E、附录F、附录G、附录H、附录J、 附录K、附录L、附录M、附录N是指导性文件的附录。 本指导性文件的附录P、附录Q是提示的附录。 本指导性文件由国家邮政局科学研究规划院提出并归口。 本指导性文件起草单位：湖南省邮电科学研究院 本指导性文件主要起草人：梁志保肖萃林刘江宁 关懿新 杨宝龙武耀辉刘春福 国家邮政局标准化指导性文件 邮政综合计算机网应用系统开发文档规范 Application Development Documents Specification YZ/Z0032-—2001 in Integrated Postal Services Networking 范围 1 本指导性文件规定了邮政综合计算机网应用系统开发文档（简称开发文档）的种类、文档结构和编 写格式、正文的编制要求以及提交方式。 本指导性文件适用于邮政综合计算机网应用系统的开发文档编制工作。 2引用标准 下列标准或指导性文件中所包含的条文，通过在本指导性文件中引用而构成为本指导性文件的条 文，所示版本均为有效。所有标准或指导性文件都会被修订，使用本指导性文件的各方应探讨使用下列 标准或指导性文件最新版本的可能性。 GB1526-89信息处理一一数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文 件编制符号及约定 3文档种类 开发文档包括以下几类： 开发计划 需求说明书 概要设计说明书 详细设计说明书 模块开发卷宗 测试计划 测试说明书 测试分析报告 用户操作手册 安装手册 运行维护手册 开发进度报告 开发总结报告 4文档结构和编写格式 4.1文档结构 开发文档统一由封面、文档修改记录、目录、正文和附录组成。 4.2编写格式 开发文档的纸张采用A4规格。 国家邮政局2001-08-27批准 YZ/Z0032—2001 4.2.1封面 开发文档封面的格式如图1所示。 邮政综合计算机网应用系统开发文档 (三号、黑体) 版本号： 文档编号： (小四、黑体) (小四、黑体) 《应用系统名） (文档名> 编制单位： 编制人: 审核人： 批准人： 编制日期： (四号、黑体) 图1开发文档封面的格式 YZ/Z0032—2001 开发文档封面应填写的内容包括以下几点。 4.2.1.1版本号 字体：宋体： 字号：五号； 格式：Vx.xx，其中x.xx用阿拉伯数字表示，从1.00开始编号。 4.2.1.2文档编号 字体：宋体； -字号：五号； -格式：XXYYZZ，其中：XX是应用系统的缩写，YY是某一开发文档的编码（见表1）， ZZ是相应开发文档的顺序编号（从01开始编号）。 表1开发文档的编码 文档名称 文档编码 文档名称 文档编码 开发计划 KFJH 需求说明书 XQSMS 概要设计说明书 GYSJSMS 详细设计说明书 XXSJSMS 模块开发卷宗 MKKFJZ CSJH 测试计划 测试说明书 CSSMS 测试分析报告 CSFXBG 用户操作手册 YHCZSC 安装手册 AZSC 运行维护手册 YXWHSC 开发进度报告 KFJDBG 开发总结报告 KFZJBG 4.2.1.3应用系统名 字体：黑体； 字号：一号。 4.2.1.4文档名 一字体：黑体； 一字号：二号。 4.2.1.5编制单位、编制人、审核人、批准人、编制日期 -字体：黑体； 字号：四号。 开发文档封面的示例参见附录P（提示的附录）。 4.2.2文档修改记录 文档修改记录记载对上次提交文档的修改情况。 文档修改记录的格式参见附录Q（提示的附录）中表Q1所示。 4.2.3目录 目录的内容包括章、节和附录的编号、标题及所在页的页码。标题与页码之间用“..….”连接。 目录页采用小写罗马数字（i、i、ii、iv...）顺序编号，整个目录仅有一页时不编号。 “目录”2字采用三号黑体。 目录内容采用五号宋体。 4.2.4正文 正文是文档的主体，正文的内容必须与相应软件生命周期各阶段的实际情况保持完全一致。 正文的章节格式如图2所示。 章节层次一般不超过4级，如果还需分层，则可用1）、2）...或①、②....编序。 3 YZ/Z0032—2001 第1级（章） 第2级（节) 第3级（段） 第4级（条） 1 2 2.1 2.2.1 3 2 .2 2.2.2 2.2.3.1 (2.3 2.2.3 2.2.3.2 1 2.2.3.3 图2正文的章节格式 正文各级标题均采用五号黑体字，正文内容采用五号宋体字。 4.2.5附录 附录按字母顺序编号，如附录A、附录B..。每个附录中的小节编号须加上附录编号字母，如附 录A的小节编号为A1、A2...。 附录页采用阿拉伯数字接着正文部分连续编号。 附录的字体、字号与4.2.4正文一样。 5文档正文的编制要求 5.1开发计划 开发计划确定系统开发的总目标，对开发所需要的资源作出估计，对开发进度作出安排，从项目组 织、质量保障和配置管理等方面制定完成开发任务的实施计划。 开发计划文档的编制应在软件设计开始之前由软件开发方完成，并得到系统建设方和监理方的认 可。 开发计划的内容要求见附录A。 5.2需求说明书 以“业务需求”、“开发计划”为依据，对开发软件的功能和性能进行准确的逻辑描述，说明软件设 计的限制、软件与外部的接口和软件的其它有效性需求。 需求说明书的编制应在软件设计开始之前，在软件建设方的参与下由软件开发方完成，并得到建设 方的认可。 需求说明书的内容要求见附录B。 5.3概要设计说明书 以需求说明书文档为依据，设计软件总体结构，定义系统各软件模块及软件模块之间的关系。 概要设计说明书的内容要求见附录C。 5.4详细设计说明书 以概要设计说明书文档为依据，进行软件过程设计，定义程序模块及程序模块的处理算法。 详细设计说明书的内容要求见附录D。 5.5模块开发卷宗 以详细设计说明书文档为依据，每完成一个模块或一组密切相关模块的复审时编写一份，应该把所 有的模块开发卷宗汇集在一起。目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工 作的管理和复审，并为将来的维护提供非常有用的技术支持。 模块开发卷宗的内容要求见附录E。 4