导言:
软工视频告一段落,即将踏上写文档的末班车,希望这段时间的学习不要那么浮躁,可以踏踏实实地学点知识,理论加上实践,这个美好的11月,期待一个更加进步的自己,在写文档正式开始之前,先来概述一下,大致熟悉文档,再次与它见面就不会陌生了。
一、 软件文档的概念(what)
文档是指某种数据媒体和其中所记录的数据,具有永久性,固定不变的格式,具有规范性,可被人和计算机阅读。
软件文档是记录软件开发活动和阶段性成果、理解软件所必需的阐述性资料,它是一系列信息的载体。
二、软件文档的目的(why)
在这个软件盛行的时代,用户的需求复杂多变,为了满足用户的需求,各种各样的软件数量日益增多,但随着软件工作环境(硬件系统或系统软件的升级换代)变化,软件只重视开发而忽略维护,引发了软件危机,软件危机的表现主要是用户需求不满足、软件质量差、成本和进度不准确,可维护性差,文档不完整、不合格等,为了更好地解决软件危机,让软件开发规范化和工程化,软件文档起着举足轻重的作用,所以很有必要重视软件生存周期(计划、开发、运行)软件文档的编写,它是软件开发的关键环节。
促进对软件的开发、管理和维护
便于各种人员(用户和开发人员)的交流
三、软件文档的要求(requirement)
1.文档的及时性
在软件生存周期中,每一个阶段都应有明确的文档与之对应,作为一切计划和工作开展的依据和参照,一定要及时更新和完善,确保高质量。
2.文档的完整性
任何一个文档都应当是完整的、独立的,它应自成体系。
3.文档的准确性
文档的行文应当十分准确,不能出现多义性的描述。统一课题几个文档的内容应当是协调一致,没有矛盾的。
4.文档的规范性
文档的编写有着固定的格式,有一个统一的格式标准,可被计算机和人阅读。
四、软件文档的分类(classification)
1.依形式来分:
一类是开发过程中填写的各种图表,称之为工作表格;
一类是编制的技术资料或技术管理资料,称之为文档或文件
2.依文档产生和使用范围:
开发文档 、管理文档和用户文档
声明:本站部分文章及图片源自用户投稿,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!