需求规格文档实例

a. 引言  

a. 1目的

a. 2文档约定

a. 3预期的读者和阅读建议

a. 4产品的范围    

a. 5参考文献

b. 综合描述  

b.1产品的前景     

b.2产品的功能     

b.3用户类和特征 

b.4运行环境 

b.5设计和实现上的限制     

b.6假设和依赖     

c. 外部接口需求  

c. 1用户界面

c. 2硬件接口

c.3软件接口 

c.4通信接口 

d.系统特性

d.1说明和优先级 

d.2激励/响应序列

d.3功能需求 

e.其它非功能需求

e.1性能需求 

e.2安全设施需求 

e.3安全性需求     

e.4数据存储

e.5软件质量标准属性 

e.6业务规则 

e.7用户文档 

f.其它需求     

附录A:词汇表       

附录B：分析模型

附录C:待确定问题的列表   

a.引言

a.1目的：

同学们在大学中经常会在网上买东西，然而快递送到的时候却有可能不方便取。于是我们想到可以设计一个系统，让快递的主人指定别人帮Ta代取快递，达到不耽误时间的效果。

a.2文档约定：无

a.3预期的读者和阅读建议：

我们的需求文档将对组内的五名成员进行展示，并就技术方面进行交流，同时也会提供给校园内的用户查阅，同时询问他们进一步的需求。在经过组内的讨论后，我们认为这个软件需要将收货方和代取方的详细信息收集起来，同时将对每个用户进行实名认证，用户在登录自己的账号后才可以行使一些隐藏的操作。

a.4产品的范围：

这个软件面向的是北理工良乡校区的全体师生。

a.5参考文献：无

b. 综合描述

b.1产品的前景

背景：由于校园的快递收取分布位置相对部分同学较远，或者快递送达时，自己不在校园或者没有时间取时而产生快递领取的超时现象，同时也因为超时领取而影响后面的快递分发，为了尽可能的减少此类现象的发生，通过这样一个快递代取的平台让快递能够得到及时领取。

本快递代取平台为新型产品。

b.2产品的功能 

功能：1.由一些离快递分发地近的同学帮助离得远的同学或者忙碌不在校的同学代领快递，从而使快递第一时间被领取；2.代领取人员可以通过帮忙领取快递而获得一定费用报酬。

b.3用户类和特征

本平台主要面向北京理工大学的中关村校区以及良乡校区的全体师生。

 

b.4运行环境

b.4.1硬件要求

Windows系列操作系统，Unix类操作系统，Linux类操作系统，Mac操作系统。

b.4.2软件要求

IE浏览器,Chorme浏览器,Firefox浏览器均可兼容。

b.5设计和实现上的限制

经费限制：100元；

开发期限：2020年6月14日前完成；

硬件限制：硬设备有部分配置比较低，完成本需求说明中的功能和性能要求没有问题；

编程语言：Java Script，HTML，PHP，MySql；用MySql数据库，因为MySql开源免费，可节省费用；使用PHP，因为PHP简洁易用；

安全和保密要求：CA加密认证；

开发过程中须遵守的某些标准或规则：编码规范采用相关编程文档

本平台服从中华人民共和国相关法律规定，北京理工大学校规。

b.6假设和依赖

b.6.1 浏览器

推荐IE10及以上、火狐、谷歌浏览器（建议使用推荐版本火狐浏览器：FirefoxEXR52.4.0）；

b.6.2 影响需求陈述的因素

（1）、假设多数同学愿意通过给予报酬让别人代取快递，快递收取平台在校园成功推广的可能性，以及存在一定的市场。

（2）、暂定的付费方式：网络支付与现金支付。

c.外部接口需求

c.1用户界面

c.1.1.登录界面

完成情况：可以进行登录用户的匹配以及相关的注册功能，以及确保后面操作均是该用户行为。

待完成情况：忘记密码未能完成

c.1.2.注册界面

完成情况：能够完成数据传入数据库，并且能对传入数据进行简单的判断是否存在违规操作。

待完成情况：对传入数据无法进行更深度的判断，存在比较大的局限性。

c.１.３.服务选择

完成情况：可以对需要的服务进行选择。

c.1.4.个人数据中心

完成情况：可以查看个人用户名，同时查看自己发布的快递基本信息以及详情

待完成情况：撤回功能以及头像更新功能未完成，同时对于接收快递的信息展示功能未完成。原型如下：

c.1.5.我发布的快递信息查看

完成情况：可以从数据库中调取相关信息展示。

待完成情况：确认接收功能未完成，同时存在需要刷新页面才能更新操作的bug。

c.1.6.我接收的的订单情况

待完成情况：还未能与数据库进行连接。

c.1.7.发布订单信息

完成情况：实现了数据传入数据库，并且可以实现简单的数据判断，且根据发布日期随机生成订单序号。

待完成情况:对于数据不能进行更加精确的判断，布局粗糙。

c.1.8.接收订单界面

完成功能：可展示数据库中未被接收的订单。

待完成情况：筛选排序功能未实现。

C.1.9.接收订单界面详情

待完成情况：接收后产生调整数据库内容，并在接收订单界面下架该订单。

c.2硬件接口

本产品为软件，不需要额外的硬件接口

c.3软件接口

本产品使用visual code studio，dream weaver开发，主要运用了c，html，php语言，目前可运行在Linux系统上，未来预计拓展为可在windows7/8/10系统上运行，数据库采用了MySQL数据库，操作系统为Linux。

c.4通信接口

本产品需实现与服务器间的通信，因而需要rj45接口，就是网线接口，目前为演示方便服务器架设在本地，故只需要本地网络。  

d.系统特性

d.1说明和优先级：

首先，这个软件是面向广大师生的，所以一定要保证系统运转时仅限于良乡校区。其次，软件必须保证送货方与收货方的身份信息真实性。再次，系统可以实时测算并显示双方距离与接单时长，并能够在货物送达后显示收货成功。

d.2激励与响应序列：

首先，收货方用户登录自己的账号，若账号或密码错误将中断。将自己要取的货物及其地点进行描述，并规定送达地点及时间限制，将信息传到系统云端。送货方登录自己账号并选择接单。收货方可以观察到送货方的信息。送货完成后，系统可以提醒收货方，整个过程结束。

d.3功能需求：

（1）认证功能。送货方与收货方均可以在系统上认证自己的身份信息。（2）发送功能。收货方可以发送自己的请求，送货方可以发送送货完成的请求并提醒收货方（3）接收功能。送货方可以接收到收货方的请求，收货方可以接收到送货方的信息和送货完成的提醒。（4）定位功能：送货方可以查看到货物的位置以及目的地的位置，收货方可以观察送货方的实时位置。（５）举报功能：对于因货物运送或者安全产生的问题，可以提出举报。

e.其它非功能需求

这部分列举出了所有非功能需求，而不是外部接口需求和限制。

e.1性能需求

1速度

系统所有用户信息查询都在3秒内完成。

2负载

支持1000名学生一次性发布订单；

3吞吐量

每秒可以完成500条订单匹配；

4容量

系统可以存储5万条订单信息，1万名用户信息；

5实时性

在订单匹配成功后，用户可在0.5秒内得到订单信息。

e.2安全设施需求

e.3安全性需求

1用户账号与隐私安全

所有用户必须实名且为北京理工大学师生，后台数据库将依据相关法律规定，保护用户隐私安全；注册用户将绑定邮箱与手机号，保证账号安全。

2快递安全

平台将于学校相关部门合作，确保在代收人员代取快递后出现损坏，私藏物品的行为时，将追责并协助出布任务的人员得到应有补偿；

3收付款安全

平台确保代收人员完成任务后得到合理收益。

e.4数据存储

e.4.1.数据存储方式

使用mysql进行数据的存储。

e.4.2.数据存储内容以及获取方式

该项目涉及两个数据库，一个是有关客户的信息内容（图２），一个是有关订单的数据内容（图２）。

（图１）

Student_id:用户的学号信息，通过注册面板获得，用来标示学生身份的唯一主键。

Real_name:用户的真实姓名，通过注册面板获得。

Users_name:用户的用户名，通过注册面板获得。

Academy:用户的书院信息，通过注册面板获得。

Class_number:用户的班级号，通过注册面板获得。

Account_number:用户的账号，通过注册面板获得。

User_password:用户的密码，通过注册面板获得。

（图２）

Order_id:订单的序号，通过订单发布的时间进行一定的运算得到的字符串，是标识订单的唯一主键。

Order_place_get:获取快递的地点，通过订单发布页面获取。

Order_place+to:快递送达的地点，通过订单发布页面进行获取。

Order_time:快递需送达的时间，通过订单发布页面进行获取。

Order_money:快递订单的报酬，通过订单发布的页面获取。

Order_get_way:快递的获取方式，通过订单发布的页面获取。

Order_contact:订单的联系方式，通过订单发布页面获取。

Order_other:订单的备注，通过订单发布页面获取。

Order_publish_people_id:订单发布者的序号（学号），订单发布者在发布后，自动获取该页面用户的序号。

Order_get_people_id:订单接收者的序号（学号），订单接收者在接收后，自动获取该页面用户的序号。

Order_publish_finish:订单发布者收到订单的确认信息，初始化自动为０，当用户确认收到后至１。

Order_get_finish:订单接收者送达订单的确认信息，初始化自动为０，当用户确认收到后至１。

Order_time:该订单的生成时间，页面自动获取。

e.4.3.数据维护

对于存在超过３天未接收或者未撤回的订单管理人员进行手动删除，对于用户的访问日志每个月进行不少于一次的清理。当order_get_finish和order_publish_finish两个字段的值都为１的订单但是没有撤销，通过日志查看后若该订单已经被完成，则进行人工删除，若未被完成，则进行人为修改。

e.5软件质量标准属性

e.5.1可用性

平台系统可用性将达到98%；

2可维护性

开发人员将会对平台故障进行维护；同时不定期更新；

3可移植性

如果有需要，可以在1个月内移植平台到新操作系统；

e.6业务规则

只有持有管理员密码的用户才能看到其他用户后台信息。

e.7用户文档

在线帮助：

本平台将引导用户注册，登入，发布任务，接受任务，确认订单完成。