软件开发文档-详细设计文档
引言
引言也称前言、序言或概述经常作为科技论文的开端,提出文中要研究的问题,引导读者阅读和理解全文
编写目的
帮助开发人员理解项目的业务逻辑
术语描述
执行标准与相关文档
编码标准,文件管理标准,版本管理标准
项目概述
1、背景
2、现状
项目目标
最终要实现的目标
编码规范
前端规范,后台规范,数据库规范,中间件使用规范
系统功能概述
系统功能总图
系统总体介绍
描述下系统的总体情况
系统模块设计
模块结构图,模块汇总表,功能简述
模块功能点
【功能描述:说明该程序应具有的功能,功能结构图,原型界面,可采用IPO图(即输入一处理一输出图),类图,用例图等。】
1、输入项
【给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】
2、输出项
【给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。】
3、算法
【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】
4、逻辑流程
【用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。】
5、接口
【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构。】
6、存储分配
【根据需要,说明本程序的存储分配。】
7、注释设计
【说明准备在本程序中安排的注释,如:
a. 加在模块首部的注释;
b. 加在各分枝点处的注释;
c. 对各变量的功能、范围、缺省条件等所加的注释;
d. 对使用的逻辑所加的注释等等。】
8、限制条件
【说明本程序运行中所受到的限制条件】
9、测试计划
【说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定】
软件开发文档-详细设计文档相关推荐
- rd如何撰写总体设计文档和详细设计文档
转自:http://www.habadog.com/2012/10/18/rd-how-to-write-document/ rd需要撰写的设计文档主要分为:总体设计文档 + 详细设计文档,后简称为& ...
- 软件开发中常见英文缩写和各类软件开发文档的英文缩写
软件开发中常见英文缩写和各类软件开发文档的英文缩写: 文章复制粘贴来源于:http://blog.sina.com.cn/s/blog_7326867a0100yfdl.html 英文简写 文档名称 ...
- python软件开发-如何编写Python软件开发文档(7个技巧)
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
- 软件开发文档整理(之)一张示意图 | 清晰明了
在整个软件开发周期,开发文档是必不可少的资料,它们贯穿于整个开发周期,用来评估计划.规划进度.项目管理.软件测试.软件发布,可以说至关重要. 开发文档必须归档,没有归档的文档作用大打折扣,时效 ...
- python开发软件的实例-如何编写Python软件开发文档(7个技巧)
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
- python写软件实例-如何编写Python软件开发文档(7个技巧)
开发文档是经常被程序员忽略的工作,有时也会被管理者忽略.这往往是由于在项目生命周期结束的后期缺乏时间,以及人们认为自己不擅长写作,其中一些人确实写不好,但他们中的大多数能够完成一个良好的文档. 在任何 ...
- 软件开发文档的价值和作用
现代软件研发理念强调敏捷开发,快速迭代,高效地响应用户的需求变化.可以说,自从有了敏捷方法,有相当一部分程序员长出一口气:终于可以不用写文档了. 那么,事实真的如此吗,文档应不应该写,应该如何编写? ...
- Just enough(刚刚好)的软件开发文档什么样?
在今年与多个软件开发单位的交流中,补文档的问题多次提到,试图通过本文谈谈文档的价值,如何写刚刚好的文档. 软件开发所需要的文档在传统的瀑布型生命周期下典型的有:开发计划,需求规格说明书,设计书(有分成 ...
- 软件开发过程中的各种文档
到哪一步,就要进行相应的文档编写和整理,下面是一些文档. 文档编写标准化 在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有 针对性.精确性.清晰性.完整性.灵活性 ...
- 开发详细设计文档_郑州APP开发:开发前,进行详细设计有没有必要?
郑州燚轩软件科技有限公司● 点击蓝字关注我们 ● 一般进行软件开发 的人都知道,在进行郑州APP开发时,项目流程主要包括需求分析.概要设计.详细设计.编码和测试 ,那么在其中有了概要设计的情况下,为什 ...
最新文章
- leetcode-376 摆动序列
- [转]关于MyEclipse下的项目无法使用BASE64Encoder问题的解决办法
- 转载:使用Auto Layout中的VFL(Visual format language)--代码实现自动布局
- 补丁更新选项的禁用与恢复
- Kaldi内存泄漏问题排查
- ASP.NET下载网络图片
- c++删除文件delete_开启phpstudy中apache的put和delete请求方法并进行测试
- BZOJ 4538: [Hnoi2016]网络
- 理论篇-数理统计填坑篇
- JS 简易控制台插件 [供 博客, 论坛 运行js用]
- MathType安装指南
- unity使用TUIO协议
- win10 更新1809版后彻底关闭系统自动更新的方法
- [PPPOE]PPPD源码分析
- 数据分析实例——美国加州人口分析[isnull().any()/.unique()/merge/set_index/df.query/sort_values]
- Vollendet und in alle Einzelheiten durchgebildet
- 日语标点符号用法解说!
- 6.Oracle-安全管理
- OpenLayers入门,使用OpenLayers叠加多边形、圆形、线段和点要素到地图上
- html 名词解释 综合解释,HTML和JAVASCRIPT综合练习题2014答案