需求文档编写培训-朱哥出品必出精品

1、需求文档编写目录 需求文档简介 文档模板 范例详解 引言 产品介绍 产品功能说明 非功能性需求需求文档简介 设计人员 交互、UI人员根据需求文档设计交互及界面。 研发人员 根据文档进行编码 测试人员 根据文档进行黑盒测试阅读对象需求文档简介需求种类需求种类界面需求功能需求性能需求接口需求报表需求文档模板范例详解 标题XXX项目需求规格说明书 修订记录记录每次修改的内容、原因，可供备查。例：序号序号完成日期完成日期修改内容修改内容作者作者审查审查1 12009-9-17创建文档XXX 2 22009-12-5添加了无盘服务器负载均衡、回写热备两个用例场景的描述XXX 3 32010-1-5客户机

2、列表和服务器列表中将IP地址列修改为必显示列XXX 标题及修订记录范例详解 文档目的描述文档的内容、给什么人看可copy下面这段话。例：定义XXX项目的需求说明，收集、分析、定义用户需要和产品特征，详细描述系统功能性、非功能性、约束等需求。以供研发、UI交互设计、质量保证等人员阅读。 术语与缩写解释文档里涉及到的一些名词、缩写、术语的解释。注意，自己能理解的，不代表别人能理解！例：缩写、术语缩写、术语解释解释应用应用应用指云海客户端后台配置的所有资源的统称。控制台控制台指网维大师软件的服务端操控界面。通常安装在网吧服务器，也可以安装在其它机器上远程连接网吧服务器。引言（一）范例详解 参考资料罗

3、列本文档所引用的有关参考文献名称、作者、标题、编号、发布日期和出版单位等基本信息。 文档中标识对描述习惯、符号等的定义。例：术语、缩写术语、缩写解释解释优先级优先级功能说明中的“优先级”：H-必需实现，M-应该实现，L-可选实现，L又包括(L1L2L3)|表示可能的取值。如：客户机状态=全部|在线|离线|超管|禁用，表示客户机可能有5种状态：全部|在线|离线|超管|禁用。引言（二）范例详解描述产品的背景、目的、产品涉及的用户、产品应该遵循的标准规范、产品范围、外部系统接口，等。例如： 背景例：无盘网吧可以统一管理、节省投资，但维护复杂，对维护人员技术要求高。市面上无盘厂商也在做游戏更新产品，将

4、威胁到顺网业务。 目标例：简化无盘管理维护工作。降低顺网加盟商反水概率，进军无盘市场，提升网维大师市场占有率。产品介绍（一）范例详解 产品中的角色与系统发生交互作用的、系统之外的任何东西都是角色。可以是人，也可以是机器每个角色都通过不同的方式使用系统；或者被系统调用（使用），通常是机器或外部系统例：角色名称角色名称职责描述职责描述网管网管负责网吧中无盘、虚拟盘服务器搭建、客户机安装、日常运维管理等方面的工作网民网民使用无盘客户机、虚拟盘来玩游戏或软件的网吧消费者。产品介绍（二）范例详解 产品范围产品范围指产品或者服务所应该包含的功能，即系统边界。例1：基于网维大师7160版本，对客户端界面进行

5、优化、增加个性化桌面功能。例2：本期范围仅限于在无盘二期基础上所做的调整、完善部分。主要包括无盘、虚拟控制台的整合，网维大师客户端针对无盘模式的调整，虚拟盘针对无盘模式的调整，无盘、虚拟盘的业务控制等方面。例3：产品介绍（三）范例详解 外部系统接口1、用户界面 如：界面标准、产品风格、菜单布局，等。可以在交互方案中定义。例：符合Microsoft的GUI标准。界面支持只通过键盘操作（TAB选择控件、上下箭头可选择条目、回车可确定）2、硬件接口例：剩余金额查询及费用缴纳支持从IC卡读卡器获取（接触式IC卡，遵循ISO7816接口标准）。3、通信接口 如：电子邮件、WEB浏览器、网络通信协议，等。

6、例：运营人员审核申请业务通过，将向加盟商发送电子邮件，以确认所购买的网吧天数量。4、软件接口例：客户端系统从广告后台获取广告策略，从IDC获取广告资源，实现广告展示。注意：外部系统接口中的内容须在功能中体现。产品介绍（四）范例详解产品功能说明功能模块功能模块菜单名称菜单名称需求类型需求类型优先级优先级功能说明功能说明监控中监控中心心找回密码新增H用户忘记密码可以通过手机、邮箱找回。网吧监控新增L1按网吧查看各网吧客户机的异常数据桌面设置桌面设置 桌面图标修改L2增加了桌面图标的类型可自定义文件夹快捷方式。原因：80%的用户需要定义网吧影院、点餐系统的图标，目前他们都是使用第三方工具配置这些图标

7、，极不方便。桌面壁纸修改M增加按分组设置壁纸。系统设置系统设置IE浏览记录查询删除H此功能原本是用于网监检查时查询记录用，但现在网监要求统一安装单独的IE记录监测工具，该功能不再使用，故删除。建议做一张表，列明针对现有版本，需要新增、修改、删除的功能。除功能描述外，还可以描说明一下增加或修改某项功能的理由、数据支撑。如果删除某项功能，必须写明原因。范例详解产品功能说明 针对功能说明表中的功能，一个个地按照模板写出来（模板见下页） 交互四步曲：请求、验证、改变、回应操作人XXX系统XXX操作人XXX系统XXX 使用主动语句，主语是操作人或系统 必须是可理解、可验证的范例详解功能描述模板范例详解功

8、能描述前置条件、后置条件 前置条件：用例开始前，系统需要满足的约束 后置条件：用例结束后，系统应具备的状态 必须是系统能检测到的关键词：时间点关键词：时间点 系统系统 约束约束 检测检测范例详解功能描述前置条件、后置条件系统运行正常维护商已登录系统维护商拥有导入MAC的权限维护商已在控制台添加过客户机IP维护商已从路由器导出MAC地址文件必须符合导入格式功能概述：从TXT文件导入客户机MAC地址要与系统特点相关少说正确而无用的废话必须是系统能检测到的必须是用例开始前的检测请判断以下前置条件是否正确：范例：可用IP数量=原数量-1。系统已添加一台客户机。重启指定客户机能以超级终端运行。系统已修改

9、指定客户机的IP地址。范例详解功能描述前置条件、后置条件系统记录导入的MAC地址准则：后置条件是约束，不是动作。要记录的是结果。站在系统和测试人员的角度描述，测试人员可以进行黑盒测试。系统已记录导入的MAC地址范例详解功能描述功能说明主流程：1、用户选择身份，输入账号及密码。2、系统请求身份验证系统进行身份验证。3、身份验证系统验证身份通过。4、系统获取当前用户的权限， 调用“3.2.1监控首页”用例（参见XXXX）。扩展流程：3a1、身份验证系统验证身份不通过，返回错误信息。3a2、系统提示登录失败。针对每一步，思考：1、否定的情况2、是否有其它分支情况3、会有哪些异常范例详解功能描述功能说

10、明主流程：1、用户输入账号及密码。2、系统请求身份验证系统进行身份验证。3、身份验证系统验证身份通过。4、系统获取当前用户的权限， 调用“3.2.1监控首页”用例（参见XXXX）。扩展流程：3a1、身份验证系统验证身份不通过，返回错误信息。3a2、系统提示登录失败。版本一：版本二：1、用户输入账号及密码。2、系统请求身份验证系统进行身份验证。3、身份验证系统验证身份，返回结果。4、系统根据返回结果进行判断： 1）如果返回验证通过的信息， 系统获取当前用户权限， 调用“3.2.1监控首页”用例（参见XXXX）。 2）如果返回错误信息，系统提示错误信息，用例结束。5、范例详解功能描述功能说明注意事

11、项！主流程：1、用户勾选“开启温度监控”。2、系统将温度编辑框置为可用。3、用户输入CPU温度、显卡温度、主板温度后，点击“确定”按钮。4、系统判断温度数值，如果超出范围，提示： “数值超出范围，请重新输入”。5、不要涉及不要涉及UIUI界面的描述！界面的描述！范例详解功能描述功能说明注意事项！系统建立数据库连接，执行查询语句，从“网吧基本信息”表中查询网吧联系人。系统从基础数据表中删除维护商及网吧对应关系是功能描述，不是研发设计！是功能描述，不是研发设计！如果我是作为一个数据库脚本工具来开发，你可以这样写如果需求上强制要求必须这样实现，这时你可以将我写在“约束”里范例详解功能描述功能说明注意

12、事项！4、系统反馈应收总金额5、顾客付款6、收银员提交付款方式和金额7、系统计算找零金额8、系统反馈找零金额、打印票据9、收银员找零不要写系统无法检测的事！不要写系统无法检测的事！范例详解功能描述功能说明注意事项！系统从操作员处获取用户名和密码用户名和密码被验证会员查询商品系统给出状态提示信息系统显示天气温度情况系统立即显示，等，或者，通常使使用主动语句，明确责任用主动语句，明确责任操作员提交用户名和密码操作员提交用户名和密码系系统验证用户名和密码统验证用户名和密码会员在哪里查询？会员在哪里查询？会员提交商品查询条件，系统根据查询条件查询商品会员提交商品查询条件，系统根据查询条件查询商品描述不

13、清，研发没法做描述不清，研发没法做系统提示客户机状态，状态系统提示客户机状态，状态= =离线离线| |在线在线 系统显示最近一次收到的气温，单位摄氏度系统显示最近一次收到的气温，单位摄氏度无意义的语句无意义的语句范例详解输入数据项数据项类型类型长度及约束长度及约束默认值默认值 是否必输是否必输身份类型身份类型单选选项为：维护商、网吧维护商 是账号账号文本10个字符空是密码密码文本16个字符空是范例详解输出范例1：CPU数值超出范围，系统提示：请输入50-100之间的整数。范例2：密码验证失败，系统提示：密码错误，请重新输入！范例3：系统显示服务器列表（通常分析师写出可能发生的各种分支，交互文档中描述提示信息。如果分析师有要突出的重点，可在需分文档中给出建议文案，很多时候，我们把输出直接放在功能说明中描述了）描述该功能所有输出数据，例如：返回值的内容、界面的响应结果、输出结果的规则、非法值的处理、出错信息；范例详解非功能性需求可度量范例详解