面向对象软件设计说明书模板[1]

来源:互联网 发布:ubuntu eclipse maven 编辑:程序博客网 时间:2024/04/28 02:59
1 概述

  1.1 系统简述

  对系统要完成什么,所面向的用户以及系统运行的环境的简短描述,这部分主要来源于需求说明书的开始部分。

  1.2 软件设计目标

  这部分论述整个系统的设计目标,明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时,对于非功能性的需求例如性能、可用性等,亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考,看看其中明确了的功能性以及非功能性的需求。

  这部分必须说清楚设计的全貌如何,务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分,将解释设计是怎么来实现这些的。

  1.3 参考资料

  列出本文档中所引用的参考资料。(至少要引用需求规格说明书)

  1.4 修订版本记录

  列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。

  2 术语表

  对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说明过了,此处不用再重复,可以指引读者参考需求说明。

  3 用例

  此处要求系统用用例图表述(UML),对每个用例(正常处理的情况)要有中文叙述。

  4 设计概述

  4.1 简述

  这部分要求突出整个设计所采用的方法(是面向对象设计还是结构化设计)、系统的体系结构(例如客户/服务器结构)以及使用到的相应技术和工具(例如OMT、Rose)