需求说明文档
一、简介
1.1背景
[简单说明项目的由来]
1.2定义、缩略语
[列出文档中出现的术语并给出解释,术语包括业务术语、缩写词、英文缩写词等。业务术语可在“非功能性需求”一节中进一步说明。]
1.3约束
[列出会影响系统的需求、设计、实现或测试方式的主要限制或约束,可在“非功能性需求”一节中进一步说明]
eg,
利用Windows域管理实现单点登录和权限管理。
无需改造或升级现有的打卡设备及相应软件。
1.4参考资料
[列出本文档所参考的上游文档、资料等]
二、目标、涉众分析和范围
2.1目标
[用简单几句话描述本系统的目标,目标体现了系统的最终效果]
eg.
规范员工的上下班、请假、外出工作等行为。
方便计算员工的薪金。
方便管理各种带薪假期。
2.2涉众分析
[通过组织架构图、涉众分析表等方式,列出本系统各涉众的关注点。]
公司组织结构图
……
涉众分析表
2.3范围
[说明系统的总体范围、与其他系统的关系、系统的地域使用范围等。
说明本项目包括的服务内容,如软硬件采购、培训、实施等。
需特别说明本系统不包括什么内容。]
三、业务概念分析(结构建模)
[描述软件要管理或处理的业务对象以及对象之间的关系,注意这里要从业务的角度来描述各种概念、对象之间的关系,切记从软件设计角度或者数据库设计角度来描述。
如果概念比较复杂,那应该在这里分层次描述,可以在这里设小节分层次描述。比较好的表达办法是:先描述大体的情况,然后逐一说明每一部分。]
3.1概述
[宏观说明业务概念的总体情况,让读者对业务概念有大致的了解。]
eg.
本系统要管理的事情主要有:打卡记录、请假申请、外出申请。
3.2业务概念一览
3.3外出申请
3.4请假申请
四、业务流程分析(流程建模)
[描述本系统将要管理的或者是相关的业务流程,可用UML的活动图、状态机图、顺序图来表述。]
4.1概述
[从总体上说明业务流程状况,在后续小节可分层次展开逐一详细说明。]
eg.
请假申请和外出申请都需要审批,请假申请和外出申请在审批流程不同阶段处于不同的状态。
4.2外出申请审批流程
活动图
……
状态机图
……
顺序图
……
4.3请假申请审批流程
活动图
……
状态机图
……
顺序图
……
五、功能性需求
5.1执行者分析
[分析各执行者之间的关系。]
5.2总用例图
[通过一个宏观的用例图来总体说明系统的功能,后续小节可分层次展开逐一详细说明。]
5.3普通员工的用例
[应先给出用例图,必要时应逐一说明每一个用例的具体情况。]
图+表
六、非功能性需求
[本节列出来的内容都需要考虑,如无需考虑可写“无”,如果缺失了需要考虑的内容,请添加想要的小节。]
6.1系统架构要求
[用部署图、构件图来描述本系统在软件架构上的要求,本系统与现有IT软硬件、第三方系统的关系等。需描述清楚系统运行所需的软硬件环境,哪些是客户环境现已具备的,那些事需要调整的等。]
6.2接口
[描述本系统和外部软、硬件的接口规定。
接口需要考虑的内容:
1.接口范围;
2.接口的名称
3.输入、输出参数的格式]
6.3安全性
[系统在通信、数据完整性、保密等方面的要求。]
6.4性能
[系统在响应速度、能承受的压力等方面的要求。]
6.5界面
[用户对界面流、首页、报表格式、界面风格等方面的要求,这部分内容可在《用户体验设计》中进一步细化。]
七、附录
[列出需求分析过程中获得的各种原始或中间材料]