“软件开发详细设计说明书” 这样写到底沾不沾 ??
时隔百日,种树大壮 回来喽!!!
咳咳。。。
近期,这不正在积极备战 第二届HarmonyOS开发者创新大赛嘛。
为了力保作品的实用度和创新性,洒家已经进行了一个半月的构思啦
接下来,就需要书写一份内容完整且条理清晰的 软件开发详细设计说明书 了哈
几经查阅、整理。俺终于整理出这么一份 “设计说明书” 模板。
嗯么,由于如此正式地进行软件开发尚属首次,相关经验不是很丰富。
故希望社区里的各位观众老爷们,来帮忙瞅瞅,这模板到底 OK 不 OK。
软件开发详细设计说明书
1 引言
1.1 编写目的
【说明编写这份详细设计说明书的目的,指出预期读者】
1.2 背景
【说明: a,待开发软件名称;】
【 b,本项目的任务 提出者,开发者,用户
运行该程序系统的计算中心】
1.3 定义
【列出本文件中用的专业术语的定义、外语首字母组词的原词组】
1.4 参考资料
【列出相关参考资料,如:】
【a. 本项目的经核准的计划任务书或合同、上级机关批文;
b. 属于本项目的其他已发表的文件;
c. 本文件中各处引用到的文件资料,
包括所要用到的软件开发标准
列出这些文件标题、文件编号、发表日期和出版单位,
说明能够取得这些文件的来源】
2 程序系统的结构
【用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)
的 名称、标识符、他们之间的层次结构关系。】
3 程序设计说明
【本章将逐个给出各个层次中的每个程序的设计思考
以下是一些一般情况,对于一个具体的模块,
尤其是层次比较低的模块或子程序,
其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同
】
3.1 程序描述
【给出对该程序的简要描述,主要说明安排设计本程序的目的意义
并且,还要说明本程序的特点(如:是否 是 常驻内存)
是否子程序?是重人的还是不可重人的?有无覆盖要求?
是顺序处理还是并发处理 等。。。
】
3.2 功能
【说明该程序应该具有的功能,可采用IPO图
(即输入—处理—输出图)的形式】
3.3 性能
【说明对该程序的全部性能要求,
包括对精度、灵活性和时间特性的要求】
3.4 输入项
【给出对每一个输 入 项的特性,
包括名称、标识、数据的类型和格式
数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的
来源和安全保密条件 等等... ...
】
3.5 输出项
【给出对每一个输 出 项的特性,
包括名称、标识、数据的类型和格式
数据值的有效范围、输出的形式。
数量和频度、输出媒体、对输出图形及符号的说明
安全保密条件 等等... ...
】
3.6 算法
【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】
3.7 流程逻辑
【用图表(例如流程图、判定表等)
辅以必要的说明来表示本程序的逻辑流程】
3.8 接口
【用图的形式说明本程序所隶属的上一层模块
及隶属于本程序的下一层模块、子程序,
说明参数赋值和调用方式,
说明与本程序相直接关联的数据结构(数据库、数据文卷)
】
3.9 存储分配
【根据需要,说明本程序的存储分配】
3.10 注释设计
【说明准备在本程序中安排的注释,如:
a. 加在模块首部的注释;
b. 加在各分枝点处的注释;
c. 对各变量的功能、范围、缺省条件等所加的注释;
d. 对使用的逻辑所加的注释等等。
】
3.11 限制条件
【说明本程序运行中所受到的限制条件】
3.12 测试设计
【说明对本程序进行单体测试的计划,
包括对测试的技术要求、输入数据、预期结果、
进度安排、人员职责、设备条件驱动程序
及桩模块等的规定。
】
3.13 尚未解决的问题
【说明在本程序的设计中尚未解决
而设计者认为在软件完成之前应解决的问题。
】
4 logo、标识符设计说明
备注:{大部分内容取自:https://blog.csdn.net/sgear/article/details/6199064 }
{本人仅对格式和少数语句进行了修改}
楼主把你的点子亮出来
暂时保密🤪 🤪
确实写的不错,但是,这个文章就是太太老了,2011年。说缺点肯定得罪人,但是,采用太旧容易掉到坑里面。例如:
1、假如写《多端部署》,用你这个文档里面写输入,输出,到下个设备时,又要写输入,输出。从这个文档里面就没有体现华为带来的好处。华为的意思是一次编写,多端部署。
2、假如写《跨端迁移》,没有输入,没有输出,程序从一个设备迁移到另外一个设备了。用您的文档,如何表述,从一个设备迁移到另外一个设备。
是吧,
🤔 🤔 🤔
这的确是一个值得思考的问题
🧐 🧐