提高效率的七个方法写嵌入式软件设计文档
ARM与嵌入式','ARM与嵌入式 2024-06-06
对于嵌入式软件来说,方案设计时,常常会写详细设计文档。比如我这一周,有两天时间都在写文档。

我觉得详细设计文档,能说清楚设计的内容就差不多了,可以用流程图、思维导图、框图来做说明配合少许文字。必要的时候,可以定义出一些对外服务的接口,或者备注需要外部模块提供的接口。

1引言

1.1编写目的

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

1.2背景

a. 待开发软件系统的名称:机房收费系统 b. 项目的任务提出者:张老板 c. 项目的开发者:齐先生 d. 项目的用户:志晟网络的全体用户 e. 运行该软件的计算站(中心):志晟网络全体硬件设备

1.3定义

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

1.4参考资料

列出有关的参考资料,如: a. 详细设计说明书(G8567——88) b. 《软件工程概述》 李存珠编著 南京大学计算机系出版 2001年8月

2程序系统的结构

3一般用户设计说明

3.1程序描述

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

3.2功能

3.3性能

3.3.1精度

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

3.3.2灵活性

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

3.3.3时间特性的要求。

相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内

3.4输人项

3.5输出项

3.6算法

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

3.7流程逻辑

3.8接口

3.9存储分配

3.10注释设计

说明准备在本程序中安排的注释,如: a. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 b. 在变量声明阶段,大概说明变量的类型和用途 c. 在判断、循环或者顺序枝分点上注释说明程序代码的功能

3.11限制条件

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

3.12测试计划

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

3.13尚未解决的问题

暂无

4操作员设计说明

4.1程序描述

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

4.2功能

4.3性能

4.3.1精度

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

4.3.2灵活性

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

4.3.3时间特性的要求。

相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内

4.4输人项

4.5输出项

4.6算法

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

4.7流程逻辑

4.8接口

4.9存储分配

4.10注释设计

说明准备在本程序中安排的注释,如: d. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 e. 在变量声明阶段,大概说明变量的类型和用途 f. 在判断、循环或者顺序枝分点上注释说明程序代码的功能

4.11限制条件

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

4.12测试计划

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

4.13尚未解决的问题

暂无

5 管理员设计说明

5.1程序描述

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

5.2功能

5.3性能

5.3.1精度

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

5.3.2灵活性

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

5.3.3时间特性的要求。

相应时间:0.5s内 更新处理时间:0.5s内 数据的更换和传送时间:1s内

5.4输人项

5.5输出项

5.6算法

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

5.7流程逻辑

5.8接口

5.9存储分配

5.10注释设计

说明准备在本程序中安排的注释,如: a. 在模块首部注释说明模块开始编写时间、编写人员及其基本功能 b. 在变量声明阶段,大概说明变量的类型和用途 c. 在判断、循环或者顺序枝分点上注释说明程序代码的功能

5.11限制条件

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

5.12测试计划

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


声明: 本文转载自其它媒体或授权刊载,目的在于信息传递,并不代表本站赞同其观点和对其真实性负责,如有新闻稿件和图片作品的内容、版权以及其它问题的,请联系我们及时删除。(联系我们,邮箱:evan.li@aspencore.com )
0
评论
  • 相关技术文库
  • 电源
  • DC
  • AC
  • 稳压
  • 压力传感器调试需要哪些工具?

    电力系统是用电基础设施,可以说,电力系统是伟大的发明之一。通过电力系统,可以对电力进行管控。为增进大家对电力系统的认识,本文将对电力系统的谐振以及铁磁谐振予以介绍。如果你对电力系统具有兴趣,不妨继续...

    2小时前
  • 太阳能逆变器如何实现太阳能转换

    逆变器的使用,能够帮助我们把直流电变为交流电。在上篇文章中,小编对太阳能逆变器的性能以及太阳能逆变器的作用有所阐述。为增进大家对太阳能逆变器的认识,本文将对太阳能逆变器的特点予以介绍。如果你对太阳能...

    2小时前
  • 专家教你调试传感器

    变送器是从传感器发展而来的,这也是很多朋友分不清变送器和传感器的原因。为增进大家对变送器的认识,本文将对流量变送器的特点,以及涡街流量变送器的安装予以介绍。如果你对流量计具有兴趣,不妨继续往下阅读哦...

    2小时前
  • APF的实用意义揭秘

    APF,就是常聊的有源电力滤波器。虽然APF是老生常谈的话题,但是你对APF真的了解吗?为增进大家对APF的认识,本文将对APF的优势,以及APF和无源电力滤波器予以介绍。如果你对APF具有兴趣,不妨和小编一起继续往下认...

    2小时前
  • APF究竟有哪些实用意义?

    APF也就是有源电力滤波器,可以说,APF有源电力滤波器在现实中具备广泛的应用。为增进大家对APF有源电力滤波器的认识,本文将对APF有源电力滤波器,以及APF有源电力滤波器的实用意义予以介绍。如果你对APF具有兴趣...

    2小时前
  • 如何测试TVS二极管的工作状态?

    TVS是二极管中的一种重要类型,在很多领域中都有TVS二极管的应用。为增进大家对TVS的认识,本文将对TVS二极管的一些应用方向以及TVS二极管正负极的区分方式予以介绍。如果你对TVS具有兴趣,不妨和小编一起继续往下...

    2小时前
  • 工频逆变器和高频逆变器的区别

    逆变器也就是一个转换器,通过逆变器,可以将直流电能转变为交流电。为了增进大家对逆变器的认识,本文将对工频逆变器的应用领域以及工频逆变器和高频逆变器的区别予以介绍。如果你对逆变器具有兴趣,不妨继续往下...

    2小时前
  • 太阳能逆变器的原理功能

    逆变器是工业、生活中常用设备之一,即便是家用电器中,也存在逆变器的身影。上篇文章中,小编对工频逆变器有所阐述。为增进大家对逆变器的认识,本文将对太阳能逆变器的效率以及太阳能逆变器的功能作用予以介绍。...

    2小时前
  • 塑壳断路器和微型断路器的区别

    断路器,其实是一种开关装置。断路器按其使用范围具有两种分类,一是高压断路器,二是低压断路器。为了增进大家对断路器的认识,本文将对塑壳断路器和微型断路器的区别予以介绍。如果你对断路器具有兴趣,不妨继续...

    2小时前
  • PWM波的生成机制及其在电路设计中的实践指南

    pwm的控制方法、pwm波的产生过程以及pwm死区问题,小编在往期文章中都有所探讨。为了不忘pwm的根本,在这篇文章中,小编想和大家一起聊聊pwm的一些基础概念以及高级概念予以介绍。如果你对pwm具有兴趣,不妨继续往...

    2小时前
  • DSP中PWM死区问题的解决方法是什么?

    在上篇文章中,小编对pwm的几种控制方式进行了特别详细的阐述。但是,大家对pwm波的产生过程,以及DSP里的pwm死区问题具备多少认识呢?为了帮助大家扫清pwm的这两个问题,小编特地带来了这篇pwm相关文章。如果你对本...

    2小时前
  • 晶闸管整流器操作流程:详细指南与步骤

    在上篇文章中,小编对晶闸管整流器的工作原理、晶闸管整流器的应用范畴有所介绍,大家是否对晶闸管整流器产生了兴趣呢?为继续增进大家对晶闸管整流器的认识,本文将对晶闸管整流器的操作流程、晶闸管整流器的注意事...

    2小时前
下载排行榜
更多
评测报告
更多
EE直播间
更多
广告