撰写软件详细设计是一个系统化的过程,需要清晰地描述软件系统的各个组成部分及其相互关系。以下是撰写软件详细设计的一般步骤和要点:
确定详细设计的详细程度
明确详细设计说明书的“详细”到什么程度。例如,是否每个页面都需要详细说明。
组织文档结构
以系统模块为小组将文档分成不同的小组,确立大的框架。
考虑每个页面要描述的内容,重点是“详细描述页面之间的关联”。
程序描述
描述页面的功能。
列出页面所提供的功能。
关联关系
描述页面之间的关联,特别是哪些参数的改变会对其他页面产生影响以及产生什么样的影响。
使用表格形式展示页面中的元素,包括左边列出的数据库中的表、中间列出的关键字段(必须包含参数)和右边列出的受该页面影响的其它页面。
逻辑流程
通过流程图的方式表达页面之间的逻辑流转。
突出用户操作和判断用户操作是否规范的部分。
编写目的
说明编写详细设计方案的主要目的,即为程序员编码提供依据。
背景
包含待开发软件系统的名称、系统基本概念、开发项目组名称等。
参考资料
列出详细设计报告引用的文献或资料,包括作者、标题、出版单位和出版日期等信息。
设计概述
说明详细设计的任务及目标。
描述系统性能需求、运行环境、条件与限制等。
详细设计方法和工具
简要说明详细设计所采用的方法和使用的工具,如HIPO图方法、IDEF(I2DEF)方法、E-R图、数据流程图、业务流程图、选用的CASE工具等。
具体实现
以流程图的方式表达逻辑流转。
如果使用设计模式,简单介绍一下设计模式及其使用理由。
考虑模块的性能要求,分别考虑高性能和普通性能的版本实现。
测试案例
分类编写正常使用的测试案例、典型的异常案例、极端异常案例和性能测试案例。
风险及应对措施
分析程序在外部环境异常时的正确反应,如输入数据异常、系统异常、网络异常、外部系统崩溃、压力过大等。
注释设计
在模块首部、变量声明阶段和判断、循环或顺序分支点上添加注释,说明程序代码的功能。
存储分配
说明程序中各个部分的存储分配情况。
限制条件
保证程序正确运行所需满足的限制条件。
通过以上步骤和要点,可以撰写出一份详细、清晰、易于理解的软件详细设计文档,为后续的编码工作提供坚实的基础。