软件规格说明书 – (Specification)
软件规格说明书应包含软件功能说明书和软件技术说明书
-
软件功能说明书 (Functional Spec)
- 主要用来说明软件的外部功能和用户的交互情况,以用户的角度告知本软件产品的特点/功能描述软件产品的功能、输入、输出、界面、功能的边界问题、功能的效率(对用户而言)、异常情况等,不涉及软件内部的实现细节。
- 请详细描述软件提供的功能以及各个功能模块的详细的界面截图,菜单,对话框,等等,并对其作用进行描述。
功能说明应尽量清楚描述以下内容
a) 对相关的概念的定义
b) 规范假设前提
c) 为避免误解,对某些边界条件进行界定
d) 描述主流的用户/软件交互步骤
e) 指出功能的某些副作用
f) 服务质量的说明。
-
软件技术说明书(设计文档)
- 技术说明书又叫设计文档,它用于描述开发者如何去实现某一功能,或相互联系的一组功能。告知软件团队或者相关合作方特定功能是如何实现的。
- 内容包括数据结构,关系型数据库模型,编程语言机器工具的选择,相关算法等。并对该技术选型以及设计依据做出简要的设计合理性说明。
设计文档应该说明工程师的设计是如何体现下列原则的
a) 软件如何实现抽象 ( Abstraction )
b) 内聚/耦合 /模块化 是如何实现的
c) 信息是如何隐藏和封装的
d) 界面和实现的分离是如何实现的
e) 如何处理错误情况
f) 程序模块对于运行环境、相关模块、输入输出参数有什么假设?
g) 软件是如何保证应对变化的灵活性
h) 如何保持对大量数据的处理能力