详细的设计文档该怎么写？请注意这些地方...

详细的设计文档该怎么写？请注意这些地方...

引用

CSDN

1.

https://blog.csdn.net/u010632165/article/details/124287850

详细的设计文档是软件开发过程中非常重要的一环，它能够帮助开发者清晰地理解系统结构和功能实现。本文将以一个机房收费系统的设计文档为例，详细介绍如何编写一份详尽的设计文档。

1 引言

1.1 编写目的

该文档在概要设计的基础上，进一步细化系统结构，展示软件结构的图标、物理设计、数据结构设计及算法设计，详细介绍了系统各个模块的实现方式，包括涉及的算法和逻辑流程。

1.2 背景

• 待开发软件系统的名称：机房收费系统
• 项目的任务提出者：张老板
• 项目的开发者：齐先生
• 项目的用户：志晟网络的全体用户
• 运行该软件的计算站（中心）：志晟网络全体硬件设备

1.3 定义

• 系统结构：对系统整体布局的宏观描述
• 算法：对程序内部流程计算的逻辑表达方式

1.4 参考资料

• 详细设计说明书（G8567——88）
• 《软件工程概述》 李存珠编著 南京大学计算机系出版 2001年8月

2 程序系统的结构

3 一般用户设计说明

3.1 程序描述

该程序用于查看学生的上下机情况及学生信息，不涉及管理功能，主要将学生信息输入数据库，经过系统处理后得到新的数据信息。

3.2 功能

3.3 性能

3.3.1 精度

• 软件的输入精度：只保留整数部分
• 软件的输出精度：只保留整数部分
• 传输过程中的精度：只保留整数部分

3.3.2 灵活性

• 运行环境的变化：该软件适用于现在流行的操作系统
• 精度和有效时限的变化：因不同情况而变化
• 计划的变化和改进：根据用户需求随时更新和升级软件

3.3.3 时间特性的要求

• 响应时间：0.5秒内
• 更新处理时间：0.5秒内
• 数据的更换和传送时间：1秒内

3.4 输入项

3.5 输出项

3.6 算法

时间差 = 下机时间 - 上机时间
金额按照基本数据设定和时间差判断金额的计算方法

3.7 流程逻辑

3.8 接口

3.9 存储分配

3.10 注释设计

• 在模块首部注释说明模块开始编写时间、编写人员及其基本功能
• 在变量声明阶段，大概说明变量的类型和用途
• 在判断、循环或者顺序分支点上注释说明程序代码的功能

3.11 限制条件

必须保证程序正常连接到服务器

3.12 测试计划

• 测试用例：选取有代表性的数据，避免使用穷举法
• 测试方法：使用白盒测试法，语句覆盖、判定覆盖、条件覆盖等操作

3.13 尚未解决的问题

暂无

4 操作员设计说明

4.1 程序描述

该程序用于查看学生的上下机情况及学生信息，包括注册、充值、修改信息、退卡以及对操作员工作记录的查询工作。一般用户没有此权限。

4.2 功能

4.3 性能

4.3.1 精度

• 软件的输入精度：只保留整数部分
• 软件的输出精度：只保留整数部分
• 传输过程中的精度：只保留整数部分

4.3.2 灵活性

• 运行环境的变化：该软件适用于现在流行的操作系统
• 精度和有效时限的变化：因不同情况而变化
• 计划的变化和改进：根据用户需求随时更新和升级软件

4.3.3 时间特性的要求

• 响应时间：0.5秒内
• 更新处理时间：0.5秒内
• 数据的更换和传送时间：1秒内

4.4 输入项

4.5 输出项

4.6 算法

总金额 = 剩余金额 + 充值金额
剩余金额 = 总金额 - 消费金额
退还金额 = 剩余金额 - 消费金额

4.7 流程逻辑

4.8 接口

4.9 存储分配

4.10 注释设计

• 在模块首部注释说明模块开始编写时间、编写人员及其基本功能
• 在变量声明阶段，大概说明变量的类型和用途
• 在判断、循环或者顺序分支点上注释说明程序代码的功能

4.11 限制条件

必须保证程序正常连接到服务器

4.12 测试计划

• 主要在注册模块，注意选取不同的数据，确保输入数据合法，符合规定的范围
• 对于充值、退卡以及信息维护模块，举例测试并观察测试结果是否符合逻辑规律

4.13 尚未解决的问题

暂无

5 管理员设计说明

5.1 程序描述

管理员模块主要是对整个系统的管理，包括对操作员的查看和管理，用户的添加和删除，系统基本数据的设定以及结账工作。

5.2 功能

5.3 性能

5.3.1 精度

• 软件的输入精度：只保留整数部分
• 软件的输出精度：只保留整数部分
• 传输过程中的精度：只保留整数部分

5.3.2 灵活性

• 运行环境的变化：该软件适用于现在流行的操作系统
• 精度和有效时限的变化：因不同情况而变化
• 计划的变化和改进：根据用户需求随时更新和升级软件

5.3.3 时间特性的要求

• 响应时间：0.5秒内
• 更新处理时间：0.5秒内
• 数据的更换和传送时间：1秒内

5.4 输入项

5.5 输出项

5.6 算法

总金额 = 剩余金额 + 充值金额
剩余金额 = 总金额 - 消费金额
退还金额 = 剩余金额 - 消费金额

5.7 流程逻辑

5.8 接口

5.9 存储分配

5.10 注释设计

• 在模块首部注释说明模块开始编写时间、编写人员及其基本功能
• 在变量声明阶段，大概说明变量的类型和用途
• 在判断、循环或者顺序分支点上注释说明程序代码的功能

5.11 限制条件

必须保证程序正常连接到服务器

5.12 测试计划

• 主要在结账模块，注意选取不同的时间段，观察结账是否符合系统逻辑运算法则
• 对于添加删除用户模块，举例测试并观察测试结果是否符合逻辑规律
• 最后是日结账单和周接账单，检验报表是否正确，能否正确预览和打印

5.13 尚未解决的问题

暂无