写项目的来龙去脉
写该项目达到的目的。
例如
建设该项目是为了提高本区域的地质灾害预警预报的及时性。
和该项目相关的人员和其负责的内容
在这里要找到主要干系人,也就是说能对系统功能拍板的人。
项目的运行环境,包括硬件环境和软件环境
硬件条件限制、例如只能购买一台服务器,网络条件限制,只能走政务内网或局域网。或者已经指定了数据库和开发平台,开发语言等。还有工期等。
项目一共需要哪些数据,数据的格式要求等。并标注好哪些数据已有,哪些数据还没有,谁负责,什么时候提交等信息。
例如空间数据,系统需要什么空间参考的空间数据,格式是什么,是.shape文件还是.gdb文件夹。
属性数据是需要什么格式,可以是excel。但每个数据Excel文件具体什么格式,我们在设计文档里面可以定义。
该模块主要描述系统主要的业务流程图和整理出来的用例图以及用例规约。
下图为业务流程图示例:
下图为业务用例示例:
下表为一个业务用例规约:
用例名称 |
区域预警分析 |
执行者 |
预警中心工作人员 |
前置条件 |
已经有了气象部门提供的当前雨量和未来24小时雨量数据 |
后置条件 |
生成预警分析结果 |
涉众利益 |
预警中心工作人员:担心操作太复杂。 领导:担心时间操作长,预报不及时。 |
基本路径 |
1. 执行者选择气象部门给的雨量文件,设置预报的时间范围。 2. 系统新建了一个预警工程,并在地图上展示出来,并且标注好预报雨量数据。 3. 执行者点击区域预警分析,执行分析。 4. 分析后检查无误,执行生成预警结果操作。 |
扩展路径 |
a. 气象部门给的雨量文件不符合规范 1. 在导入雨量文件的时候,检查雨量文件格式,如果格式有问题,就提示用户。 2. 用例结束。 b. 用户选择的时间范围不对 1. 如果用户选择的开始时间大小或等于结束时间,则提示用户。 2. 用例结束。 |
业务规则 |
1. 气象台给的雨量数据是有固定的格式的。 2. 气象台给的雨量数据文件中包含的区域必须和系统中区域名称一致。 3. 预警的时间范围,起始时间必须小于终止时间。 |
非功能需求 |
1. 不要让用户选择工程的路径,默认保存在系统的某一路径下。 2. 在新建过程中,可以按照默认的信息新建一个工程,不需要任何新的输入。 |
涉及约束 |
在此列出系统有哪些模块,每个模块包含的字模块和功能列表。
子系统 |
模块 |
子模块 |
功能 |
后面描述每个功能的作用。(简单描述即可)最好可以画一些界面。
界面风格。
外部硬件接口
外部软件接口
故障处理等
响应时间
无故障运行时间
其他特殊操作对性能的要求
原文:http://www.cnblogs.com/xzbluemap/p/3716620.html