详细的设计文档该怎么写?请注意这些地方... |
您所在的位置:网站首页 › 算法网站开发方案设计怎么写 › 详细的设计文档该怎么写?请注意这些地方... |
点击上方“小麦大叔”,选择“置顶/星标公众号” 福利干货,第一时间送达 大家好,我是小麦。对于我们嵌入式软件来说,方案设计时,常常会写详细设计文档。比如我这一周,有两天时间都在写文档。 我觉得详细设计文档,能说清楚设计的内容就差不多了,可以用流程图、思维导图、框图来做说明,配合少许文字。必要的时候,可以定义出一些对外服务的接口,或者备注需要外部模块提供的接口。 1引言 1.1编写目的该文档在概要设计的基础上,进一步的细化系统结构,展示了软件结构的图标,物理设计、数据结构设计、及算法设计、详细的介绍了系统各个模块是如何实现的,包括涉及到的算法,逻辑流程等。 预期的读者:程序员 1.2背景a. 待开发软件系统的名称:机房收费系统 b. 项目的任务提出者:张老板 c. 项目的开发者:齐先生 d. 项目的用户:志晟网络的全体用户 e. 运行该软件的计算站(中心):志晟网络全体硬件设备 1.3定义系统结构:对系统整体布局的宏观的描述 算法:对于程序内部流程计算的逻辑表达方式。 1.4参考资料列出有关的参考资料,如: a. 详细设计说明书(G8567——88) b. 《软件工程概述》 李存珠编著 南京大学计算机系出版 2001年8月 2程序系统的结构该程序指对学生的上下机情况及学生信息进行查看,没有涉及管理功能,只是将学生的信息输入数据库,经过系统处理后得到新的数据信息。 3.2功能软件的输入精度:只保留整数部分 软件的输出精度:只保留整数部分 传输过程中的精度:只保留整数部分 3.3.2灵活性A.运行环境的变化:该软适用于现在流行的操作系统。 B.精度和有效时限的变化:因不同情况而变化。 C.计划的变化和改进:根据用户的需求随时软件做出更新和升级。 3.3.3时间特性的要求。相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内 3.4输人项时间差=下机时间-上机时间 金额按照基本数据设定和时间差判断金额的计算方法 3.7流程逻辑说明准备在本程序中安排的注释,如: a. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 b. 在变量声明阶段,大概说明变量的类型和用途 c. 在判断、循环或者顺序枝分点上注释说明程序代码的功能 3.11限制条件必须保证程序正常的连接到服务器 3.12测试计划测试用例:选取有代表性的数据,避免使用穷举法 测试方法:使用白盒测试法,语句覆盖、判定覆盖、条件覆盖等操作。 3.13尚未解决的问题暂无 4操作员设计说明 4.1程序描述该程序指对学生的上下机情况及学生信息进行查看,包括注册、充值、修改信息、退卡以及对操作员工作记录的查询工作。一般用户没有此权限。 4.2功能软件的输入精度:只保留整数部分 软件的输出精度:只保留整数部分 传输过程中的精度:只保留整数部分 4.3.2灵活性A.运行环境的变化:该软适用于现在流行的操作系统。 B.精度和有效时限的变化:因不同情况而变化。 C.计划的变化和改进:根据用户的需求随时软件做出更新和升级。 4.3.3时间特性的要求。相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内 4.4输人项总金额=剩余金额+充值金额 剩余金额=总金额-消费金额 退还金额=剩余金额-消费金额 4.7流程逻辑说明准备在本程序中安排的注释,如: d. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 e. 在变量声明阶段,大概说明变量的类型和用途 f. 在判断、循环或者顺序枝分点上注释说明程序代码的功能 4.11限制条件必须保证程序正常的连接到服务器 4.12测试计划主要在注册模块、注意选取不同的数据,确保输入数据合法,符合规定的范围 对于充值、退卡以及信息维护模块,举例测试并观察测试结果是否符合逻辑规律。 4.13尚未解决的问题暂无 5管理员设计说明 5.1程序描述管理员模块主要是对整个系统的管理,包括对操作员的查看和管理,用户的添加和删除,系统基本数据的设定以及结账工作。 5.2功能软件的输入精度:只保留整数部分 软件的输出精度:只保留整数部分 传输过程中的精度:只保留整数部分 5.3.2灵活性A.运行环境的变化:该软适用于现在流行的操作系统。 B.精度和有效时限的变化:因不同情况而变化。 C.计划的变化和改进:根据用户的需求随时软件做出更新和升级。 5.3.3时间特性的要求。相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内 5.4输人项总金额=剩余金额+充值金额 剩余金额=总金额-消费金额 退还金额=剩余金额-消费金额 5.7流程逻辑说明准备在本程序中安排的注释,如: a. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 b. 在变量声明阶段,大概说明变量的类型和用途 c. 在判断、循环或者顺序枝分点上注释说明程序代码的功能 5.11限制条件必须保证程序正常的连接到服务器 5.12测试计划A.主要在结账模块,注意选取不同的时间段,观察结账是否符合系统逻辑运算法则 B.对于添加删除用户模块,举例测试并观察测试结果是否符合逻辑规律 C.最后是日结账单和周接账单,检验报表是否正确,能否正确预览和打印。 5.13尚未解决的问题暂无 感谢您的阅读,希望对您有所帮助! 如果觉得文章有帮助,麻烦帮忙点赞、收藏、转发,谢谢! 原文地址:https://blog.csdn.net/qizhi666/article/details/84241088?depth_1- 转自公众号:嵌入式大杂烩 版权声明:本文来源网络,版权归原作者所有。版权问题,请联系删除。 —— The End —— 往期推荐
高手经验分享,嵌入式开发出现BUG的常见原因
一分钟看懂角动量守恒定律
可视化的Keil工程配置模板,一招提高单片机开发效率
如何DIY一个复古的显像管时钟?
新手经常忽略的嵌入式基础知识点,你都掌握了吗?
一个有趣的项目,OLED实现"裸眼3D" 点击上方名片关注我 你点的每个好看,我都认真当成了喜欢 |
今日新闻 |
点击排行 |
|
推荐新闻 |
图片新闻 |
|
专题文章 |
CopyRight 2018-2019 实验室设备网 版权所有 win10的实时保护怎么永久关闭 |