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

只看该作者 · 2022-4-21 13:50

1.1编写目的

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

预期的读者：程序员

只看该作者 · 2022-4-21 13:50

1.2背景

a. 待开发软件系统的名称：机房收费系统

b. 项目的任务提出者：张老板

c. 项目的开发者：齐先生

d. 项目的用户：志晟网络的全体用户

e. 运行该软件的计算站（中心）：志晟网络全体硬件设备

只看该作者 · 2022-4-21 13:51

1.3定义

系统结构：对系统整体布局的宏观的描述

算法：对于程序内部流程计算的逻辑表达方式。

只看该作者 · 2022-4-21 13:52

本帖最后由 micoccd 于 2022-4-21 13:54 编辑

1.4参考资料

列出有关的参考资料，如：

a．详细设计说明书（G8567——88）

b．《软件工程概述》李存珠编著南京大学计算机系出版 2001年8月

只看该作者 · 2022-4-21 13:53

本帖最后由 micoccd 于 2022-4-21 13:55 编辑

只看该作者 · 2022-4-21 14:07

本帖最后由 micoccd 于 2022-4-21 14:08 编辑

3.1程序描述

该程序指对学生的上下机情况及学生信息进行查看，没有涉及管理功能，只是将学生的信息输入数据库，经过系统处理后得到新的数据信息。

只看该作者 · 2022-4-21 14:07

本帖最后由 micoccd 于 2022-4-21 14:10 编辑

3.2功能

只看该作者 · 2022-4-21 14:10

3.3性能3.3.1精度

软件的输入精度：只保留整数部分

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

3.3.2灵活性

A．运行环境的变化：该软适用于现在流行的操作系统。

B．精度和有效时限的变化：因不同情况而变化。

C．计划的变化和改进：根据用户的需求随时软件做出更新和升级。

3.3.3时间特性的要求。

相应时间：0.5s内

更新处理时间：0.5s内

数据的更换和传送时间：1s内

只看该作者 · 2022-4-21 14:13

3.4输入项

只看该作者 · 2022-4-21 14:14

3.5输出项

只看该作者 · 2022-4-21 14:18

3.6算法

时间差=下机时间-上机时间

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

只看该作者 · 2022-4-21 14:19

3.7流程逻辑

3.8接口

3.9存储分配

只看该作者 · 2022-4-21 14:22

3.10注释设计

说明准备在本程序中安排的注释，如：

a．在模块首部注释说明模块开始编写时间、编写人员及其基本功能

b．在变量声明阶段，大概说明变量的类型和用途

c．在判断、循环或者顺序枝分点上注释说明程序代码的功能

3.11限制条件

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

3.12测试计划

测试用例：选取有代表性的数据，避免使用穷举法

测试方法：使用白盒测试法，语句覆盖、判定覆盖、条件覆盖等操作。

3.13尚未解决的问题

暂无

只看该作者 · 2022-4-21 14:23

4操作员设计说明4.1程序描述

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

4.2功能

只看该作者 · 2022-4-21 14:23

4.3性能4.3.1精度

软件的输入精度：只保留整数部分

软件的输出精度：只保留整数部分

传输过程中的精度:只保留整数部分

4.3.2灵活性

A．运行环境的变化：该软适用于现在流行的操作系统。

B．精度和有效时限的变化：因不同情况而变化。

C．计划的变化和改进：根据用户的需求随时软件做出更新和升级。

4.3.3时间特性的要求。

相应时间：0.5s内

更新处理时间：0.5s内

数据的更换和传送时间：1s内

只看该作者 · 2022-4-21 14:24

4.4输入项

4.5输出项

4.6算法

总金额=剩余金额+充值金额

剩余金额=总金额-消费金额

退还金额=剩余金额-消费金额

只看该作者 · 2022-4-21 14:25

4.7流程逻辑

4.8接口

4.9存储分配

4.10注释设计

说明准备在本程序中安排的注释，如：

d．在模块首部注释说明模块开始编写时间、编写人员及其基本功能

e．在变量声明阶段，大概说明变量的类型和用途

f．在判断、循环或者顺序枝分点上注释说明程序代码的功能

4.11限制条件

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

4.12测试计划

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

4.13尚未解决的问题

暂无