软件产品设计规范书的撰写提纲和模版

1．  文件的梗概和介绍：

l         总结：在设计规范书的开头，对整个开发项目做个总结。用简单几个段落从宏观的角度对整个项目的目的和它所开发的功能能做一个描述。

l         范围：说明设计规范文件所叙述的范围，包括文件中各个部分的内容大纲。

l         读者：简要地描述阅读和理解此份设计规范文件的读者，及其必要的前提和知识背景。

文件的修订历史：注明这份文件自初稿后的所有修订历史，包括修订日期、改动的内容和理由、谁作的修改，以及修改内容的页数。

2．  开发项目的目标：用段落文字总结以下内容：

l         远景：总结整个开发的远景，也就是开发的战略目的或目标的定义。

l         设计目标：陈述开发的结果所需要解决的具体问题，以及为达到这些目的所做的相关功能设计的概述性总结。

l         项目理由的辩护：说明为什么需要进行这个项目、开发这个功能或产品。

l         项目的客户和合作者：列出项目开发出的结果所要服务的具体客户，以及项目进程中所要以来的合作伙伴、包括企业内部其它部门的合作者和企业外部的合作者。

l         项目的风险以及成功的依赖者：列出整个项目所面临或可能会遇到的风险。

l         项目进度的里程碑：用表格的方式将整个项目的里程碑详细地列出来，并对每个里程碑完成结束的衡量标准做总结陈述。

l         使用方案和系统流程图：用逻辑图或其它图像来说明系统的数据处理的流程、各种组件单元之间怎样互相配合来提供所设计的功能，注明各种数据的输入、输出、和处理等等。

3．  功能需求的总结：在这一章里详细列出软件所有应该开发的功能。每个功能应该有相对应的客户使用方案为基础。最好的方法是用表格逐步列出产品必须支持的使用方案，以及每个使用方案所依赖的功能。

4．    功能的具体设计：在这一章里详细总结和列出软件所有功能的具体设计。对每个具体的设计进行详细的称述，并配上所需要的图像进行解释。对每个具体的设计进行包括以下内容的详细陈述：

l         所提供的功能、性能或其它服务。

l         使用界面的解说，包括软件总体的运行界面的框架、不同的视窗的功能、菜单（ Menu ）、工具条（ Tools Bar ）以及按键（ Buttons ），状态条（ Status Bar ），图释（ Icon ），以及每个对话框（ Dialog Box ）的设计和形象，产品的徽标（ Logo ），启动画面（ Splash Screen ）等等。它们还应该包括每个控制键和输入时段的使用法、系统的反应和回馈的行为，以及每个出错的信息、格式、和具体的文字，等等。

产品使用说明（ Online help ）的设计、连接、内容要求。

5．  设计的考虑 : 因素：总结其它设计中必须满足的要求：

l         运行平台的要求：此产品或系统对运行环境的各种要求，如操作平台、硬件、网络连接、使用规章等等。

l         性能要求及可以接受的衡量的准则，以及对产品安装的功能、安全性、国际化和地方化的要求等等。

6．  开发时间表：列出该项目的开发时间表、对每一具体开发任务所需的人力及时间的初步估计，及所有的项目里程碑。

7．    项目成功所依赖的因素：总结所有可以估计到的外在制约因素，特别要写明哪些因素是该项目成功所依赖的，如特别的人才、设备、所需的技术、某些外部团队的支持或必须完成的组件等等。

8．    未解决的问题：总结和列出所有尚未解决的问题，或有待近一步调查商讨才能定出答案的有关设计方案和计划，及任何与客户尚未达成一致的事项，等等。

结尾页：设计规范书通过的签字——当设计文件最后审核通过后，各团队领导和客户代表在此签字。

段奇    2006年8月9日 星期三