CX-WI-0009-07软体设计文件编写WI.docVIP

作 业 指 导 书 文件名称：软体设计文件编写WI 文件编号：CX-WI-0009-07 发行日期：2000/11/01 版 本：1  目 录 目 录 2 1. 目的 3 2. 适用范围 3 3. 内容 3 3.1?? 总体设计说明书 3 3.1.1简介 3 3.1.2总体设计 3 3.1.3模块设计 3 3.1.4数据结构设计 3 3.15接口设计 4 3.2 详细设计说明书 4 3.2.1简介 4 3.2.2 模块流程及说明(包括各子模块) 4 3.2.3 需求追溯 4  目的 为规范公司软体设计文件的编写，其中包括总体设计和详细设计两个说明文件的编写。 总体设计说明书又称系统设计说明书，是对程序系统的设计考虑，为详细设计奠定基础； 详细设计说明书又称程序设计说明书，是对一个软件系统每一个程序(包括每个模块或子程序)的设计考虑，为程序员编写程序提供依据。 如该软件系统结构简单，其详细设计说明书的有关内容可合并入总体设计说明书中不重复的部分。 适用范围 本公司之软体设计。 内容 3.1?? 总体设计说明书 3.1.1简介 3.1.1.1 文件目的 说明本总体说明书的目的。 3.1.1.2 文件背景 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户。 3.1.1.3 术语 列出本总体设计说明书中专门术语的定义和英文缩写词的原词组。 ????3.1.1.4 参考文件 包括： 项目经核准的产品构想方案/合同； 项目开发计划； 需求规格说明书(版本)； 测试计划（初稿）； 用户手册（初稿）； 文档所引用的相关作业指导书。 3.1.2?? 总体设计 3.1.2.1基本设计概念和处理流程 3.1.2.2软件结构 3.1.2.3开发环境及运行环境 a.软件开发环境：软件支持、硬件支持 b.软件运行环境：PC 机运行环境 3.1.2.4尚未解决的问题 3.1.3模块设计 用系统流程图表示(包括各模块或子程序)。 3.1.4数据结构设计 3.1.4.1 数据库格式 3.1.4.2 数据库结构定义 ?清楚描述每一个数据表的结构，包括表名、索引字段、字段说明、字段名称、数据长度、数据输入/输出类型，若是较大规模的产品，此部分由数据要求说明书详细描述。 3.15接口设计 3.1.5.1外部接口 与公司其它产品接口的描述 3.1.5.2内部接口 说明各个模块之间接口。 3.1.6 系统出错处理设计 3.1.6.1 出错信息 3.1.6.2 补救措施 3.1.6.3 系统维护设计 3.1.7 需求追溯 3.2 详细设计说明书 3.2.1简介 3.2.1.1 文件目的 说明本详细设计说明书的目的。 3.2.1.2 文件背景 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户。 3.2.1.3 术语 列出本详细设计说明书中专门术语的定义和英文缩写词的原词组。 3.2.1.4参考文件 包括： 项目经核准的产品构想方案/合同； 项目开发计划； 需求规格说明书、总体设计说明书(版本)； 测试计划（初稿）； 用户手册（初稿）； 文档所引用的相关作业指导书。 3.2.2 模块流程及说明(包括各子模块) 3.2.2.1 程序流程图 3.2.2.2 功能 3.2.2.3 具体说明： 功能、算法/方法说明、参数说明、变量说明、返回值说明、步骤说明 3.2.2.4 各模块之间的接口函数的定义和描述 ?3.2.3 需求追溯 为了便于软件设计及其参考人员，检讨产品需求规格书中的各项需求描述在设计说明书中已全部被涵盖，并且能够清楚地检索从产品需求规格至软件设计文件之追溯；因此要求，在该节内容列出以产品需求规格书描述项目为序，与软件设计文件各描述项目（以内容索引号参照）之间的追溯表，可参考例1，在需求与设计间建立追溯关系。 例： 表 3.5: 需求至设计之追溯 ???????????? 产品需求规格项目??? ? 对应软件设计文件内容索引及名称 ???????????????? 3.1?? 在线登录??? ???? 3.4.7? 登录处理 3.4.8? 网络联机 ????????????????????????? ．．．????? ??????? ．．． ???????????? 3.1.5 登录失败???? 3.4.12 错误处理 ????????????????????????? ．．．??? ???????? ．．． 软体设计文件编写作业指导书 Documen