详细设计应该包含哪些内容?

虽然GJB438B规定了软件设计说明的编写要求,但是很多组织编写的部件设计和详细设计的内容却几乎雷同。这其实违背了详细设计要达成的对部件进行详细设计的目标。究其原因,还是这些组织的软件开发人员因为刚实施GJB5000,还不熟悉详细设计如何编写。

在《软件设计说明中的几个难点——设计决策、执行方案、详细设计的写法》中,笔者已经给出了详细设计的编写实例,这里再给出另外一种详细设计应编写的内容。

  1. 模块描述

对模块/单元/类进行简要描述,主要说明设计它的目的/意义和特点。

  1. 功能

描述模块/单元/类的功能。

  1. 性能

描述模块/单元/类的性能要求。

  1. 输入项

描述模块/单元/类的每一个输入项。

  1. 输出项

描述模块/单元/类的每一个输出项。

  1. 设计方法(算法)

如果有,应描述模块/单元/类所使用的算法,具体的计算公式及计算步骤。

  1. 流程逻辑

使用流程图等图表来描述模块/单元/类的逻辑流程。

  1. 接口

描述本模块/单元/类与其他相关模块/单元/类间的接口关系,说明涉及的参数传递方式。

  1. 存储分配

如果有,说明本模块/单元/类的存储分配要求。

  1. 注释设计

描述对软件程序的注释要求。

  1. 限制条件

描述本模块/单元/类在运行或使用过程中的限制条件。

  1. 测试计划

描述对本模块/单元/类进行单元测试计划的要求。

  1. 尚未解决的问题

描述当前设计中尚未解决而在系统完成之前应解决的问题。

以上的详细设计内容中,1~ 9项应当不可或缺,10~13项可以进行裁剪。

如果你不知道详细设计怎么写,不妨参考上面的内容。

这正是:

详细概要应不同,内容设计十几种

不看整体看局部,参考实例可致用

参考书目:软件工程:软件建模与文档写作,作者:龙浩,出版社:人民邮电出版社

(0)

相关推荐

  • 基于SOA架构的开发策略详解

    面向服务的开发模式已经是为大家熟知的下一代智能汽车开发模式了,由于SOA(Service Oriented Architecture)架构的灵活性和可扩展性,而这个恰恰与「软件定义汽车」的思路不谋而合 ...

  • 寒假阅读积累,为什么别的同学只看了一两本书,仍比你看几十本书的效率高……

    很多家长都有这样的疑问,平时很注重孩子的阅读练习,寒假更是陪读,参加各类阅读打卡的活动,为什么一到做阅读理解还是答题不准确呢?而且明明孩子语文基础并不差,一个寒假能阅读几十本书,可是作文也写不好.是家 ...

  • 【HETA】风冷热泵空调系统的设计方法

    在空调系统设计过程中,空调负荷计算是第一步.其次才是空调热泵机组的选型和机组数量的确定,水泵管路等选配,最后系统安装还需考虑位置以及相应的安装维护措施. 一:空调负荷的计算 1.空调负荷受什么影响? ...

  • 电动汽车高压连接器的方向在哪里?

    国内主机厂在高压连接器的选型上趋势应该是什么? 高压连接器的螺栓使用和风险 从整车的发展角度来说车辆高压单元,会越发的往电池和多合一控制单元高度集成化: 电池平台化已经是主流是OEM的必修工作,随之带 ...

  • 求包含文本内容的单元格中的数字之和

    单元格中的数据包含文本和数字(如图1),如何使用公式求出该单元格中的数字之和? 先不看答案,自已动手试一试. 公式思路 先将文本屏蔽,然后求数字之和. 公式 数组公式如下: =SUM(IFERROR( ...

  • 大腿痛包含的内容?(有点长)

    大腿后侧疼痛的诊断 大腿后侧的肌群有靠外侧的股二头肌和靠内侧的半腱半膜肌,它们由坐骨神经支配.因此,大腿后侧疼痛时,首先要检查股屈肌群是否正常?屈肌群有无拉伤或其他损伤史,以明确有无股肌群损伤.股肌群 ...

  • 学术海报poster需要包含哪些内容?

    不论你是一名学生,一名工程师,还是一个平面设计师,能够使用各种演示方法有效地传达你的想法是很重要的.海报在科学或学术交流中是一种非常有效的媒介,经常用于会议和讨论会的演示.Poster是静态的.可视化 ...

  • 监理问答2:建设工程监理主要包含哪些内容?

    问:建设工程监理主要包含哪些内容? 答:1.术语 2.0.2建设工程监理:工程监理单位受建设单位委托,根据法律法规.工程建设标准.勘察设计文件及合同,在施工阶段对建设工程质量.进度.造价进行控制,对合 ...

  • 创艺园分享:主题公园概念设计包含哪些内容?

    主题公园,不同于日常所见所见的散步赏花型的公园,也不是各种游乐设施集中游乐场所,主题公园一定是有自己的主题,顾名思义是有主题的,它是以一个概念.一个形象.一个故事甚至是一系列的故事人物为核心开展的多元 ...

  • 高企申报材料包含哪些内容?

    本文关键词:高企申报|高企申报材料 高企申报材料是高企申报过程中必须要提交的材料,对整个申报流程有这巨大的影响,企业申报高企时一定要做好材料的准备工作.那么高企申报材料都包含哪些内容呢?今天小编就整理 ...

  • 俄罗斯降低Twitter访问速度 指其长期包含违禁内容

    <莫斯科时报>在报道中介绍,俄罗斯联邦通信.信息技术和大众传媒监督局表示,从2021年3月10日开始,该部门针对推特采取了集中应对措施,以保护俄罗斯公民,并要求推特遵守俄罗斯法律.目前,推 ...

  • 股份有限公司章程应包含哪些内容

    公司章程是公司必备的规定公司组织及活动基本规则的书面文件.那么股份有限公司的公司章程应包含哪些内容?上海公司注册网小编为大家详细介绍. 股份有限公司章程应包含哪些内容 我国公司法第82条对股份有限公司 ...

  • 交易管理——#交易计划包含的内容有哪些#...

    一个好的交易计划,应包含如下内容: 进场步骤: 出场步骤; 好中最好的进场时机; 好中最好的出场时机; 进场前的风控计划和进场后的风控计划: 持仓和资金管理计划等等.