CX-WI-0009-06产品规格说明书编写WI.doc

产品规格说明书编写作业指导书作 业 指 导 书文件名称：产品规格说明书WI文件编号：CX-WI-0009-06发行日期：2000/11/01版 本：1 目 录目 录21.目的32.适用范围33.内容33.1 引言33.1.1目的33.1.2背景33.2项目概述33.2.1 被开发产品的一般描述33.2.2 被开发产品的功能43.2.3 实现语言43.2.4 用户特点43.2.5 一般约束43.3具体需求43.3.1 功能需求43.3.2 外部接口需求43.3.3 性能需求53.3.4 产品属性需求53.3.5 数据需求53.4需求追溯54.参考文件61. 目的产品需求说明书的编制是为了使用户和产品开发者双方对该产品的运行环境、功能和性能需求的初始规定有一个共同的理解，使之成为整个开发工作的基础，为概要设计提供需求说明。2. 适用范围本公司所开发之项目。3. 内容3.1引言3.1.1目的a. 说明开发本产品的目的；b. 说明编写本产品说明书的目的；c. 说明产品需求说明所预期的读者。3.1.2背景a 标识要开发的产品（名称，代码）；b 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户；c 说明该产品与其它有关产品的相互关系。3.1.3参考资料a. 列出本项目经核准的任务书或合同和上级机关的批文；b. 列出编写本产品需求说明书时参考的文件、资料、技术标准以及它们的作者、标题、编号、发布日期和出版单位等。3.2项目概述3.2.1 被开发产品的一般描述描述被开发产品的主要组成，相互联系和外部接口，可用系统流程图的层次结构描述，如图1： 图1 层次结构图示例3.2.2 被开发产品的功能简述被开发产品的功能，可用系统流程图的层次结构描述。3.2.3 实现语言列出所采用的编程语言。3.2.4 用户特点描述最终用户具有的受教育水平、工作经验及技术专长。3.2.5 一般约束给出影响承办单位在设计产品时的约束条款和当需求发生变化时该产品对这些变化的适应能力即灵活性的需求。3.3具体需求3.3.1 功能需求用文字、图表或数学公式详细描述被开发产品的输入、处理、输出以及在上述过程中发生的基本操作。对每一类功能，按下述四小节描述。3.3.1.1 引言a. 描述该产品功能及使用方法；b. 列出与功能有关的背景材料。3.3.1.2 输入要求a. 输入数据的描述，包括输入源、数量、度量单位和精度；b. 操作员具体的操作控制需求（如输入格式、数据类型、精度、范围自动检验等）；c. 指明引用的输入设备接口资料（包括设备型号、数量）。3.3.1.3 处理要求 描述为获得期望的输出，对输入数据及中间参数进行的操作，包括：a. 输入数据有效性检查手段；b. 操作顺序和处理过程；c. 非正常情况的响应。如溢出、通讯故障、错误处理；d. 输出数据有效性检查手段。3.3.1.4 输出要求a. 输出数据的描述，包括目的地（存储媒体和用途）、数量、度量单位和精度；b. 非法数据的处理；c. 指明引用的输出设备接口资料（包括设备型号、数量）。3.3.2 外部接口需求3.3.2.1 用户界面a. 指出用户使用产品时的界面需求。若用户通过显示终端操作，则需指定如下需求：n 对屏幕格式的要求；n 报表或菜单的页面显示格式及内容；n 用户命令的格式。b. 列出输出错误信息的格式。c. 尽可能采用开发工具构造界面，使需求定义和设计、编码相衔接。3.3.2.2 硬件接口a. 产品与系统硬设备之间每一接口的逻辑特点；b. 硬件接口支持的设备；c. 产品与硬件接口之间以及硬件接口与支持设备之间的约定。3.3.2.3 产品接口描述该产品与其它有关产品的接口关系，并指出这些产品的名字、助记符及版本号。3.3.2.4 通讯接口说明各种通讯接口及协议。3.3.3 性能需求a. 正常情况下和峰值工作条件下，在一定时间内要处理的数据总量；b. 响应时间；c. 输出结果精度。3.3.4 产品属性需求a. 正确性需求；b. 健全性需求；c. 安全保密性需求；d. 易使用性需求；e. 可理解性需求；f. 可维护性需求；g. 可测试性需求；h. 可移植性需求；3.3.5 数据需求若是较大规模的产品本节内容取消，由数据要求说明书详细描述，此部分内容同产品的功能描述一起做。必须采用设计工具，如：PowerDesigner，来进行）。3.3.5.1 数据描述a. 列出作为控制和引用而使用的静态数据元素；b. 列出动态输入数据元素；c. 列出动态输出数据元素；d. 列出产品内部生成的数据元素。3.3.5.2 数据获取a. 列出提供输入数据的机构；b. 列出数据输入介质和设备；c. 列出数据生成介质和设备。3.4需求追溯为了便于设计和参考人员检讨用户功能需求或构想方案中的各项需求是否在产品需求规格书中已全部被设计并且能够清楚的了解从系统的功能需求至产品需求规格之追溯；因此要求在该节内容列出以用户功能需求或新产品构想方案为序与产品规格需求各描述项目(以内容索引号参照)之间的追溯表。例如： 表 3.5：需求追溯 用户功能需求项目 对应产品需求规格书 1.1 浏览功能 3.4.7; 3.4.12 1.2 查找功能 3.3.2; 3.4.8 3.5附录 附录可视需要选择加入，其内容可包括： (1) 名词定义，用以定义产品需求规格中出现的名词及简称，也可直接参考其它文件。 (2) 输入输出样本格式，成本分析研究，使用者调查结果等。 (3) 有助于产品需求规格读者的背景资料。 (4) 描述产品所能解决的问题。 (5) 该机构的历史背景经验及作业特征。 (6) 针对尚未完成的产品需求项目所制作的预期完成时程与重要查核点对照表。 (7) 对于程序代码及其储存媒体所作之整合性说明