篇一：需求文档范例(教学用)
《软件需求（第2版）》，清华大学出版社，2004-11-1
【原书名】 Software Requirements,SEcond Edition [原书信息]
【原出版社】 Microsoft Press
【作者】 （美）Karl E.Wiegers
【译者】 刘伟琴 刘洪涛
【开本】 185×260 【页码】 357
D 需求文档范例 ..................................................................................................... 2
D.1 前景和范围文档 .............................................................................................. 2
D.1.1 业务需求 .............................................................................................. 2
D.1.2 解决方案的前景 ................................................................................... 4
D.1.3 范围和局限性 ....................................................................................... 5
D.1.4 业务上下文 .......................................................................................... 6
D.2 用例 ............................................................................................................... 8
D.3 软件需求规格说明 ........................................................................................ 15
D.3.1 介绍 ................................................................................................... 15
D.3.2 总体描述 ............................................................................................ 16
D.3.3 系统特性 ............................................................................................ 18
D.3.4 外部接口需求 ..................................................................................... 22
D.3.5 其他非功能性需求 .............................................................................. 23
D.3.6 附录A 数据字典和数据模型 .............................................................. 24
D.3.7 附录B分析模型 ................................................................................. 28
D.4 业务规则 ...................................................................................................... 29
1
D 需求文档范例
该附录通过“自助食堂订餐系统（Cafeteria Ordering System，COS）”这样一个假想的小型项目，阐述了本书所描述的某些需求文档和图。这里包括如下这些内容：
? 前景和范围文档。
? 用例列表和若干用例描述。
? 部分软件需求规格说明。
? 某些分析模型。
? 部分数据字典。
? 若干业务规则。
因为这仅仅是一个范例，所以我们并不打算完善这些需求元素。我们的目标只是提供一种思想，各种类型的需求信息之间彼此是如何关联的，并演示我们可能如何编写文档每一部分的内容。在一个小型项目中，将不同的需求信息综合到单一的文档中，常常是有意义的，因此我们可能没有单独的前景和范围文档、用例文档和软件需求规格说明。这些文档中的信息能够以多种其他合理的方式来组织。基本的目标是确保需求文档清晰明了、完整和易使用。
这些文档总的来说都遵循照前面章节所描述的模板，但是，因为这只是一个小型项目，所以对这些模板稍微作了一些简化。有时，会将几个部分合并起来，这是为了避免信息重复。每一个项目都应该考虑如何适应组织的标准模板，以尽量适合于项目的规模和本质。
D.1 前景和范围文档
D.1.1 业务需求
1.背景、业务机会和客户需要
2
目前，Process Impact公司的大多数员工平均每天要花费60分钟去自助食堂选择、购买并用午餐，其中大约有20分钟要花在公司和自助食堂之间的往返路程、选择自己喜欢的午餐、以及以现金方式或以信用卡方式结算餐费上。当员工出去用午餐时，他们平均有90分钟时间不在岗。有些员工提前给自助食堂打电话预订午餐，请自助食堂准备好他们所选择的午餐。但是，员工并不是总能如愿以偿，因为自助食堂有些食物己卖完，而与此同时，自助食堂又不可避免地会浪费大量的食物，因为有些食物没有卖出去而只好倒掉。早餐和晚餐同样面临着这样的问题，只是到自助食堂用餐的员工人数比午餐要少得多。
许多员工都通过允许自助食堂用户在线订餐的一个系统而提出订餐请求，要求在指定的日期和时间内将所订的午餐送到公司的指定地点。通过这样一个系统，使用这一服务的员工可以节约相当可观的时间，而且订到自己所喜欢的食物的机会也增大了。这既提高了他们的工作生活质量，也提高了他们的生产率。自助食堂提前了解到客户需要哪些食物，就可以减少浪费，并提高自助食堂员工的工作效率。要求送货上门的订餐员工将来还可以从本地的饭店来订餐，这就大大扩大了员工对食物的选择范围，并通过与饭店的大量购餐协议而有可能节约费用。Process Impact公司也可以只在自助食堂订午餐，而在饭店订早餐、晚餐、特定事件的用餐以及周末会餐。
2.业务目标（Business Objective，BO）和成功标准（Success Criteria，SC）
BO-1：初始版本发布之后的6个月内，自助食堂的食物浪费减少50%。
度量单位（scale）：自助食堂的工作人员每星期所倒掉的食物的价值。
计量（meter）：检查“自助食堂存货系统（Cafeteria Inventory System）”的日志。
过去情况（past）[2002.初步调研]：30%
一般标准（plan）：小于15%
最低标准（must）：小于20%。
注 该范例展示了使用Planguage语言来精确陈述业务目标或其他需求这样一种方法。
BO-2：初始版本发布之后的12个月内，自助食堂的运作费用减少50%。
BO-3：初始版本发布之后的3个月内，每个雇员每天的平均有效工作时间增加20分钟。
SC-1：目前通过自助食堂解决午餐问题的那些员工，在初始版本发布之后的6个月内，他们中有75%的人使用“自助食堂订餐系统”。
SC-2：初始版本发布之后的3个月内，对自助食堂满意度的季度调查评价要提高0.5.而在初始版本发布之后的12个月内，这种满意度要提高1.0。
3.业务风险（Risk）
3
RI-1：“自助食堂雇员联合会（Cafeteria Emp1oyees Union）”可能要求与雇员重新签订合同，以反映新的雇员角色和自助食堂营业时间。（可能性为0.6，影响为3）
RI-2：使用该系统的雇员太少，减少了对系统开发和变更自助食堂经营过程的投资回报。（可能性为0.3.影响为9）
RI-3：本地饭店可能并不认同减价是雇员使用这一系统的正当理由，这会减低雇员对该系统的满意度，并可能会减少他们对这一系统的使用。（可能性为0.4，影响为3）
D.1.2 解决方案的前景
1.前景陈述
对那些希望通过公司自助食堂或本地饭店在线订餐的员工来说，“自助食堂订餐系统”是一个基于Internet的应用程序，它可以接受个人订餐或团体订餐，结算用餐费用，并触发将预订餐送到Process Impact公司内的指定位置。与当前的电话订餐和人工订餐不同，使用“自助食堂订餐系统”的雇员并不需要到食堂内去用餐，这既可以节约他们的时间，又可以增加他们对食物的选择范围。
2.主要特性（FEature）
FE-1：根据自助食堂提供的选择菜单或送货菜单来订餐。
FE-2：根据本地饭店的送货菜单来订餐。
FE-3：创建、浏览、修改和删除用餐预订服务。
FE-4：注册用餐的付费方式。
FE-5：请求送餐。
FE-6：创建、浏览、修改和删除自助食堂菜单。
FE-7：预订自助食堂菜单上所没有的定做菜。
FE-8：生成自助食堂定做菜的食谱和配料列表。
FE-9：通过公司的内联网可以访问系统，或者授权的员工通过外部Internet访问系统。
3.假设（ASsumption）和依赖（DEpendency）
4
AS-1：自助食堂内有可以访问公司内联网的计算机和打印机，这样自助食堂的雇员就可以处理期望的订单量，不会遗漏任何送货时间。 AS-2：最多比请求的送货时间晚15分钟，自助食堂有送货人员和送货车辆，这样就能满足所有订单的送货要求。
DE-1：如果某饭店有自己的联机订餐系统，那么“自助食堂订餐系统”必须能与这一系统进行双向通信。
D.1.3 范围和局限性
1.
2.局限性（Limitation）和排斥性
LI-1：自助食堂的有些食物不适宜于送货，因此“自助食堂订餐系统”的顾客所用的菜单是食堂整个菜单的一个子集。
LI-2：“自助食堂订餐系统”只能用于俄勒冈州Clackamas的Process Impact公司总部内的自助食堂。
5
篇二：接口文档(范例)
接口详细设计文档 ........................................................................................................................... 1 1 编写目的 ................(转载自：www.xiaocaOfaNWen.com 小草 范 文 网:使用文档,范例)................................................................................................................... 4 2 名词解释 ................................................................................................................................... 4 3 组件分布图 ............................................................................................................................... 5 4 程序结构 ................................................................................................................................... 6
4.1 4.2 4.3 5
接入处理线程类图 ................................................................................................... 6 接收线程类图 ........................................................................................................... 7 启动控制图 ............................................................................................................... 7
程序设计说明 ........................................................................................................................... 8 5.1 5.2
对原系统的改动 ....................................................................................................... 8 ThreadInSvcProcessor 接入处理器 ......................................................................... 9 5.2.1 5.2.2 5.2.3 5.2.4 5.3
类图 ................................................................................................................... 9 时序图 ............................................................................................................. 10 流程图 ............................................................................................................. 10 ThreadInSvcProcessor类说明 ........................................................................ 12
PatternNewSyncAsyncInnerDir 同异步向内处理模式 ...................................... 17 5.3.1 5.3.2 5.3.3 5.3.4
类图 ................................................................................................................. 17 描述 ................................................................................................................. 18 流程图 ............................................................................................................. 18 类说明 ............................................................................................................. 20
5.4 ThreadReplySvcProcessor 异步应答返回处理器 ................................................. 25 5.4.1 5.4.2
类图 ................................................................................................................. 25 类说明 ............................................................................................................. 25
5.5 ClientInfo 客户端连接数据 .................................................................................. 34 5.5.1 5.5.2
类图 ................................................................................................................. 34 类描述 ............................................................................................................. 34
5.6 ClientInfoTable 客户端连接数据表 ...................................................................... 35 5.6.1 5.6.2
类图 ................................................................................................................. 35 类描述 ............................................................................................................. 35
5.7 ClientInfoTableMonitor 客户端连接数据表监控程序 ......................................... 39 5.7.1
类图 ................................................................................................................. 39
5.7.2 5.8
类说明 ............................................................................................................. 39
FrontMain 主控程序 .............................................................................................. 41 5.8.1
5.8.2
类间关系 ......................................................................................................... 41 流程图 ............................................................................................................. 42 类说明 ............................................................................................................. 43
5.8.3 5.9
问题 ......................................................................................................................... 45
编写目的
预期读者：
对接口行为和目的有一定了解的人
背景说明
? 软件系统名称：接口前端接入服务器
? 描述 <接口> 接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将
返回数据发给接入商家的行为
名词解释
? ChannelBase
渠道,通信基类，提供数据收发和释放的方法接口用子类实现来
封装了不同通信方式 目前有TCP
短连接接入， 从ACE Message_Queue中读取（IPC MessageQueue-> ACE_Message_Queue）
? Trade* trade 商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商
家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回交易的应答数据给接口平台
? 而接口（数据交换）平台是在两者之间的交换平台
?
渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统一定为主机通道工厂
篇三：软件说明文档范本
前言
本系统是一种XXXXX监控管理系统，应用射频识别技术、视频监控系统、智能控制系统、大型数据库技术、数据加密技术、防爆技术和嵌入式操作系统， 可以通过计算机通讯网络，将信息实时反馈到设置在监管部门的数据中心，进行数据处理和保存，由监管部门进行动态监管，及时掌握所有使用情况，杜绝管理漏洞和安全隐患，实行历史追溯。现对系统各模块功能做一全面说明：
一．系统登录界面
图片
二．系统首页
登录成功，即进入系统主页面。
图片
三．信息查看
进入主页面后点击信息查看，即可查看相关情况。
图片
四．查看日志
进入主页面后点击查看日志下的远程操控子菜单，即可以动态监控情况。
图片
五．实时信息
1．动态视图
进入主页面后点击实时信息下的动态视图子菜单，即可查看实时状态信息，如果有信息，则动态显示信息。
图片
点击右上方下拉菜单，选择实时监控情况，并显示所对应检验情况(若检验不合格直接不予以)、充装时间、流量以及金额。
还可以显示相关情况、包括姓名、上班时间、许可证号及身份证号。（如上图）
2．视频监控
进入主页面后点击实时信息下的视频监控子菜单，即可查看各地的实时视频信息。并可进行实时音频指导。
图片
点击右上方下拉菜单，选择后即可实时视频监控过程，右侧四个图标，绿色代表当前可用状态度，红色代表当前禁用状态，可通过点击图标进行状态控制。下侧为当前工作人员。可同时通过四个视频通道监控各地情况。（如上图）
图片
双击视频通道可详细查看操作过程，如发现有违规操作可通过点击右上方“打开对话按钮”，进行实时音频提示或警告。若情况严重可点击右侧图标上编号，控制停止非法行为。（如上图）
六．主站设置
进入主页面后点击设置下基本信息子菜单，即可对基本信息进行录入、维护。
图片
七．XX管理
1． XX信息
进入主页面后点击XX管理下XX信息子菜单，即可以浏览各区县XX详细信息，包括XXX、所地区、使用登记证号、数量、发证单位、发证时间、应用类型、厂牌型号、所属单位、负责人、姓名、联系电话等相关信息。并且还可对相关信息进行新增、修改、删除、查看等操作。
图片
2． 数据查询
进入主页面后点击XX管理下XX数据查询子菜单，即可对XX相关信息进行查询，可以根据XXX、XX、使用登记证号、发动机号、车架号、发证开始时间、发证结束时间等字段进行单独或者联合查询。
图片
3． 数据统计
进入主页面后点击XX管理下XX数据统计子菜单，即可直观查看各区XX柱状图。
图片
八．XX管理
1． XX信息
进入主页面后点击XX管理下XX信息子菜单，即可浏览各区县相关信息，包括生产厂家、出厂编号、类型、生产年月、型号、使用状态、投用日期、安装日期、使用年限、可充装次数、检验状态、车牌号等相关信息。并且还可以对XX信息进进新增、修改、删除、查看等操作。
图片
2．信息查询
进入主页面后点击XX管理下XX信息查询子菜单，即可对XX相关信息进行查
询，可以根据生产厂家、出厂编号、使用状态、类型、车牌号等字段进行单独或者联合查询。
图片
2． XX统计
进入主页面后点击XX管理下XX统计子菜单，即可对市各种类型XX使用情况动态生成饼状图。
图片
3．电子标签
进入主页面后点击XX管理下电子标签子菜单即可查询、浏览XX相关信息，并
可根据车牌号、出厂编号、使用状态、类型、生产厂家等字段进行单独或联合查询，还可以选择XX进行了发卡操作。
图片
4．标签查询
进入主页面后点击XX管理下标签查询子菜单，即可根据XX检验开始日期、结
束日期、检验状态、车牌号等字段进行单独或者联合查询。
图片
九．充装数据
1．充装数据查询
进入主页面后点击充装数据下充装数据查询子菜单，即可查询车辆XX详细记录，可以根据开始时间、结束时间、充装状态、编号、车牌号等字段进行单独或者联合查询。
图片
2．充装数据统计
进入主页面后点击充装数据下充装数据统计子菜单，即可根据各站的XX次数生
成三维柱状图，直观地展示各站的情况。
图片
3．本站充装数据统计
进入主页面后点击充装数据下本站充装数据统计子菜单，即可查看用户所在站的
XX次数生成三维柱状图，直观地展示各月份情况。
图片
3． 本站数据查询
进入主页面后点击充装数据下本站数据查询子菜单，即可对用户所在站的车辆详细记录进行浏览，并可以根据开始时间、结束时间、充装状态、编号、车牌号等字段进行单独或者联合查询。
图片