设计文档标准

程序设计书记述标准作业标准S-04001总页数7正文4附件3文件控制部门:项目管理部设计文档标准 批准人刘岩审核人张秀邦拟制人崔戈批准日期1999512生效日期1999512关联文件系统开发计划书实施规程（R-09000）更改管理标准（S-04003）设计文档管理规程（R-05004）沈阳东东系统集成有限公司沈阳东东系统集成有限公司设计文档标准S-04001REV-0更改记录序号发行日更改对象更改内容批准审查拟制01999512新发行刘岩张秀邦崔戈P-4/4S-04001REV-0设计文档标准目 录1. 目的2/42. 范围2/43.软件设计文档的种类2/44.文档的配置3/45.记载要领5.1封面3/45.2前言3/45.3更改记录4/45.4通用事项4/41.目的 统一公司软件开发过程中制作的所有文档的格式。2.范围 适用于公司软件开发过程中的所有的设计文档，若客户对提交文档格式有要求时，客户要求优先。3. 软件设计文档的种类文档名称记述内容系统提案书系统概要需求规范(系统的目的、范围、功能、性能、外部规范等)的总结，是需求分析过程的成果系统规范书系统需求规范(系统的目的、范围、功能、性能、外部规范等)的总结，是需求定义过程的成果系统设计书基于系统规范，进行系统设计的结果(硬件配置、软件配置、程序配置、功能规范、界面规范、数据库/文件/数据结构、输入/输出格式、与其他系统的输入/输出、性能、错误处理、边界条件等)的总结，是系统设计过程的成果程序设计书基于系统设计书，进行详细设计的内部设计书(模块构成一览、模块输入/输出规范书、模块处理流程等)的总结，是程序设计过程的成果程序清单源程序清单，是程序制作过程的成果测试规范书/成绩单验证需求定义、系统设计以及程序设计过程的测试规范以及测试结果归纳而成的内部设计书。对应的测试过程分为：单元(程序设计过程的验证：通常以模块单位的测试)、组合(系统设计过程的验证：通常以任务为单位的测试)、综合(需求定义过程的验证：通常为系统的运行测试)操作说明书以及手册总结系统运行时必要事项(功能规范、操作方法、输出消息的意义和对应处理方法、运行注意事项)，向利用者提供的手册安装说明书记载系统安装注意事项的向利用者提供的手册释放说明书释放版本的功能概要、兼容性、修正的不合格、已知的错误等归纳而成的向利用者提供的手册(注 1)各设计书的内容的记载方法参照相关的标准。(注2)系统开发过程中的开发体制、开发过程、作业计划、质量计划、配置管理等开发实施计划归纳而成的系统开发计划书，是质量记录，而不是设计文档。关于系统开发计划书参照系统开发计划书实施规程（R-09000）。(注3)质量管理工程对应的成果，必须作为该过程的成果记录保留下来。不要把多个过程的成果写成一个文档(例如：系统规范书制作完成经审查、批准后，即使系统设计书中要全部包含系统规范书内容，也要将系统规范书内容全部写入系统设计书，而将原来做成的系统规范书作为上一过程的成果记录保留下来)。4.文档的配置 文档的基本配置以及顺序如下： 封底（样式2）附录 正文目录封面（样式1）更改记录(样式3)前言5. 记载要领5.1封面5. 1.1标题定制软件软件包软件第1行产品/系统全称第2行产品/系统名称略称和版本号第3行文档名称和子标题(1)文档的名称参照3.中记载的名称。但是，“测试规范书/成绩单”，也可在前面附上“单元”、“组合”、“综合”、“现场”等。“手册”前也可附上“操作”、“实施”、“用户”、“参考”等。(2)文档分成多个时，用子标题进行区分：例1)系统设计书分成功能规范和界面规范时，子标题为“功能规范书”以及“界面规范书”；例2)操作说明书分成功能、操作、实施时，子标题为“功能篇”、“操作篇”以及“实施篇”。(3)版本名的命名规则参考更改管理标准（S-04003）。5.1.2其他 标识文档编号、制作年月、公司名、著作权。 编号规则参照设计文档管理规程（R-05004）。5.2前言 记载该文档的以下各项内容： 记述目的：为什么写此文档，给什么读者 注意事项：文档记述规则、读文档时应注意事项 相关文档：其他相关文档 商 标：标明引用的其他公司的商标 对象机器：标明作为本文档对象的硬件以及操作系统的名称5.3更改记录（1） 文档起草完成后，在更改记录的最上行中，序号记为“0”，更改对象、更改内容记为“初次发行”。（2） 在被更改的页的右下角记入修订版号，并在更改记录页中记入更改内容，接受审查、批准。（3） 序号每次增1。5.4通用事项5.4.1页号（1） 封面、封底不加页号；（2） 原则上，从更改页的下一页开始进行连续编号；（3） 原则上，在每一页的下部中央以“N”的形式显示页号(N为1以上(含1)的整数)5.4.2页内格式 正文页的版面设计，考虑到复印以及装订的需要，希望按如下样式进行设置：文档编号位置18mm以上18mm以上10mm以上10mm以上5.4.3项目符号、编号 原则上项目以数字附加点来标识 例) 6 61611 一个项目中含多个事项时,用如下所示符号标识,推荐第1层用数字，第2层用英文。例) (1)例2) (a)(2) (b)5.4.4图、表 对所有图表希望能有识别符号：例1) 图 12例2) 表 1设计文档标准P-3/3 (附)S-04001REV-0样式1封面 NNNNNNNNNNNNNNN年 月沈阳东东系统集成