软件项目需求规格—说明书实用的模板.docx43091.pdf

实用标准 组态建模工具需求规格说明书 西安电子科技大学 2011/5/19 文档 目录 1 概述.2 1.1 编写目的 .2 1.2 编写依据 .2 1.3 术语和缩略词 .3 2 软件概要.3 2.1 软件总体描述 .3 2.2 软件设计约束及有关说明 .3 2.3 使用者特点 .4 3 开发和运行环境.5 3.1 硬件环境 .5 3.2 支持软件环境 .5 3.3 接口 .5 3.4 控制和操作 .6 4 详细需求.8 4.1 性能需求 .8 4.2 功能需求 .9 4.3 数据需求 .12 5 故障处理需求.13 5.1 软件运行故障 .13 5.2 软件使用故障 .13 6 质量需求.15 7 其他需求.16 7.1 易用性需求.16 7.2 安全性需求.16 1 概述 1.1 编写目的 指出编写需求规格说明书的目的。下面是示例：编写此文档的目的是进一步定制软件开发的细节问题，希望能使本软件开发 工作更具体。为了使用户、软件开发者及分析和测试人员对该软件的初始规定有 一个共同的理解，它说明了本软件的各项功能需求、性能需求和数据需求，明确 标识各项功能的具体含义，阐述实用背景及范围，提供客户解决问题或达到目标 所需要的条件或权能，提供一个度量和遵循的基准。具体而言，编写软件需求说 明的目的是为所开发的软件提出：a)软件设计总体要求，作为软件开发人员、软件测试人员相互了解的基础。b)功能、性能要求，数据结构和采集要求，重要的接口要求，作为软件设计人员进行概要设计的依据。c)软件确认测试的依据。1.2 编写依据 指明该需求规格说明书的依据。一般可以写依据 XXX 软件的方案书，策划书等。1.3 术语和缩略词 缩写、术语及符号 解 释 2 软件概要 2.1 软件总体描述 从总体上描述该软件的情况，包括软件的形式（网站，运行时系统，插件等）和软件的主要的功能，使读者对该软件有一个整体的认识。一般一两段话即可。2.2 软件设计约束及有关说明 软件设计的约束以及有关说明如下所示。开发环境：编程语言：遵循的规范：软件的设计和开发过程需要严格按照合同要求，根据软件 的设计方案来进行。软件开发过程应遵循软件工程规范，对过程和版本 进行管理和控制。测试环境：可以写明在什么单位测试，测试单位使用的软硬件环境。软件交付形式：软件交付日期：其他：见合同。2.3 使用者特点 指明软件的使用者具有的特定。示例：本软件主要在甲方工作环境中使用，使用者包括项目管理人员，开发人员及 工程师等，使用者在计算机的应用、使用上不存在障碍，都在计算机的操作和使 用方面得到过相关的培训。3 开发和运行环境 3.1 硬件环境 XXX 件的运行 境 个人 算机。要求 表 3.1。表 3.1 件运行 境硬件要求 需求名称 要求 CPU 内存 硬 3.2 支持软件环境 需求名称 要求 操作系 3.3 接口 3.3.1 外部接口 明 件运行 和外部 境的接口，包括 件的界面表 形式等方面。示例：外部接口的用 界面部分按 Windows 用 件用 界面的 范来 ，界 面 格与 XXX 境保持一致，采用 XXX 以及 框等方式作 用 界面，便于用 使用。3.3.2 件接口 明 件与它运行的 件 境之 的接口。示例：本 件运行于 XXX 件及以上版本上，整个 境需要运行在 Windows 某 某版本及更高版本并装有 XXX（依 件）的操作系 之上。3.3.3 硬件接口 指明 件和运行的硬件 境的接口。Inter 或其他系列的微型 算机，内存 XXXG 以上，硬 XXXG 以上。3.3.4 内部接口 明 件内部各个模 之 的接口或 范，件各个模 数据交 的格式 等。示例：件内部的接口是通 XXX 来 行交 的。用 使用 XXX 件可以 件的各个模 之 主要通 XXX 来 行关，送数据并交 信息，从而降 低 件模 的耦合程度。3.4 控制和操作 明使用 件 需要 行的控制和操作方式。示例：XXX 件最 交付形式 XXX。控制 件运行的方法 通 鼠 双 或命令行启 XXX 境，然后通 鼠 启 XXX。XXX 件提供 XXX 等功能，各个功能 的 置及使用 符合人 使用 算 机的操作习惯，通过常用的鼠标点击，键盘输入以及菜单等形式来完成启动和使 用软件的过程，控制信号均由鼠标和键盘进行输入。4 详细需求 4.1 性能需求 4.1.1 精度要求 要按照严格的数据格式输入，对符合数据格式要求的输入进行提示。4.1.2 时间特性要求 软件启动时间：系统实时响应时间：软件使用过程中，对用户在各个功能模块的鼠标点 击、键盘输入等操作事件的响应时间需在用户能够容忍的范围之内，一 般要求小于 1 秒。数据的转换和传送时间：对软件不同模块间的数据交互，要求数据的转 换和传送时间不得超过 XXX。数据更新时间：XXX。4.1.3 灵活性要求 XXX 软件能够支持鼠标、键盘等多种操作方式的使用。软件的设计和实现需要考虑到运行环境的变化，并能够在运行环境变化的情况下正常使用。同时，软件需要兼容其他软件接口的变化，以保证在不同运行环境，不同软件接口的情况下的正常使用。具体要求如下：操作方式上的变化：软件应支持多种操作方式，例如鼠标、键盘和菜单等。运行环境的变化：软件的设计和实现需要考虑其运行环境的变化，并能 对不同的运行环境提供支持。具体而言，软件应支持 Windows 某某版 本及以上版本的操作系统，支持 XXX 环境。同其他软件接口的变化：当其他软件的接口发生变化时，XXX 软件应能 够适应接口的变化。精度和有效时限的变化：灵活性要求软件能够方便的适应精度和有效时 限的变化。计划的变化或改进：软件应具有足够的灵活性，以适应将来有可能会出 现的需求更改或增加。4.2 功能需求 经过多次需求调研，现提出 XXX 软件的功能需求。XXX 软件包括 XXX、XXX 等等模块，软件的组织结构图如图 4.1 所示。图 4.1XXX 软件研究内容 给出整个软件的用例图见图 4.2。图 4.2 软件用例图 XXX 软件的主要功能模块划分，以及各个模块主要的功能描述见表 4.1 所 示。表 4.1XXX 软件功能模块 模块名称 功能描述 XXX 模块 XXX 模块 XXX XXX 模块软件 XXX 模块 XXX 模块 XXX 模块 下面以分节的形式，详细介绍软件的各个功能模块，每个功能模块占一节，如 4.2.1,4.2.2 等等。在介绍每个功能模块时，首先给出该模块功能的总体描述，然后给出本模块的用例图，然后，在本小节内部，再往下分一级标题，分不同的点来介绍本模块的各个功能。4.3 数据需求 4.3.1 数据采集的要求：输入源：手工键盘输入；输入介质和设备：键盘，鼠标；4.3.2 数据输出要求：输出介质和设备：显示器、文件；5 故障处理需求 5.1 软件运行故障 在使用软件的过程中，当出现计算机断电，计算机内存不足等情况时，XXX 软件将出现运行故障。运行故障发生时，软件的各个功能模块将无法正常使用，启动相关功能按钮都无法进行正常的操作。对由于计算机断电引发的软件运行故障，用户在重新给计算机供电后，可以 通过重新启动计算机，并启动 XXX 软件的方式恢复软件的正常运行与使用。对 由于计算机内存不足引发的软件运行故障，建议暂时关闭软件。用户应检查并解 决计算机内存不足的问题，内存使用情况正常后，XXX 软件将恢复正常的运行 与使用。出现软件运行故障并进行修复后，应确保 XXX 软件功能的完整性，不能发 生因软件运行故障而导致工具无法继续使用的情况。5.2 软件使用故障 在软件的使用过程中，如果出现软件使用故障，应当具有报警信息提示。1)当软件依赖的文件损毁或丢失时，软件以对话框的形式进行提示，报告损毁或丢失的文件等相关错误，以帮助用户及时修复软件的正常功能。2)对软件需要用户输入项的情况，如果发生缺少输入项、输入项格式错误或不符合规则等情况，软件应以合理的方式予以提示。3)为了防止用户由于未及时保存而导致信息丢失的情况，软件提供定时保 存机制，每隔一定时间自动对信息进行保存，从而保证用户数据的安全。6 质量需求 1)软件的功能实现必须符合常用的主流 XX 软件的使用方法和操作习惯。2)XXX 工具的需要满足操作简单的要求，能够使用户没有障碍的使用该工具进行一系列的开发工作。3)要求可配置型强，便于使用者对工具的使用以及定制。4)采用可行、合理、高效的方式进行开放性的设计和实现。5)软件具有很强的适应能力，并且便于维护，不仅能很好的满足当前的需求，而且应当为后期可能的开发的工作提供很好的扩展和维护接口。7 其他需求 7.1 易用性需求 作为一款 XXX，XXX 软件的设计和实现遵循易用性原则，工具的安装和入 门，工具的用户界面布局，使用工具的操作方式等方面都应符合主流 XX 软件的 设计风格与要求。1)操作简单，设计合理。2)进行 XXX 时，XX 提供 XXX 等功能，以实现 XXX。3)使用 XXX 的过程中应有必要的操作提示信息。7.2 安全性需求 为了对软件的安装和使用进行统一的管理，安装 XXX 后，需要的到管理人 员的授权才能使用该工具。软件采用激活码-注册的方式达到这一要求。启动并 使用软件时，应对软件的授权信息进行检查，缺少授权信息情况软件将自动关闭。