软件开发文档软件开发各个阶段文档的重要性 从用户的角度分析 从软件开发角度分析 从软件测试角度分析 从维护的角度分

软件开发文档  时间:2021-08-22  阅读:()

如何判断一个人是否熟悉软件开发文档的编写?

你先看他是用什么软件编写程序的,一般只有c++ . c . JAVA . VB这几种语言可以用作软件开发,如果他熟悉软件开发的话,那么他对这几种语言都会使用,并不是他都会运用自如,好的软件程序员一般都只是精通一种语言。

这样你就可以考考他啊!

在软件开发的过程中,所生成的文档是一一交给客户,让他们签字,还是最后一块交给他们让他们验收?

与客户相关的和联系紧密的文档需要客户签收最好! 主要是需求文档与验收文档。

一般需求文档会作为开发合同的附件。

若不作为附件使用,需要签字盖章。

在开发过程中涉及需求变更的文档,必须与客户确认,并签字或盖章作为证明。

客户验收文档必须签字确认。

其他文档没必要,客户也不关心。

因为诸如设计、开发、测试等文档都是内部使用的,客户也看不懂、没利害关系,不需确认。

软件开发各个阶段文档的重要性 从用户的角度分析 从软件开发角度分析 从软件测试角度分析 从维护的角度分

软件文档能起到多种桥梁作用,使它有 助于程序员编制程序,有助于管理人员监督和管理软件开发,有助 于用户了解软件的工作和应做的操作,有助于维护人员进行有效 的修改和扩充,文档的编制必须保证一定的质量。

质量差的软件文 档不仅使读者难于理解,给使用者造成许多不便,而且会削弱对 软件的管理(管理人员难以确认和评价开发工作的进展),增高软 件的成本(一些工作可能被迫返工),甚至造成更加有害的后果(如误操作等)。

造成软件文档质量不高的原因可能是: 缺乏实践经验,缺乏评价文档质量的标准。

不重视文档编写工作或是对文档编写工作的安排不恰当。

最常见到的情况是,软件开发过程中不能按给出的进度, 分阶段及时完成文档的编制工作,而是在开发工作接近完成时集 中人力和时间专门编写文档。

另一方面,和程序工作相比,许多 人对编制文档不感兴趣。

于是在程序工作完成以后,不得不应付 一下,把要求提供的文档赶写出来。

这样的做法不可能得到高质 量的文档。

实际上,要得到真正高质量的文档并不容易,除去应在 认识上对文档工作给予足够的重视外,常常需要经过编写初稿, 听取意见进行修改,甚至要经过重新改写的过程。

高质量的文档应当体现在以下一些方面: ①针对性;文档编制以前应分清读者对象,按不同的类型、不 同层次的读者,决定怎样适应他们的需要。

例如,管理文档主要是面向管理人员的,用户文档主要是面向用户的,这两类文档不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。

②精确性:文档的行文应当十分确切,不能出现多义性的描 述。

同一课题若干文档内容应该协调一致,应是没矛盾的。

③清晰性:文档编写应力求简明,如有可能,配以适当的图 表,以增强其清晰性。

④完整性:任何一个文档都应当是完整的、独立的,它应自成体系。

例如,前言部分应作一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。

同一课题的几个文档之间可能有些部分相同,这些重复是必要的。

例如,同一项目的用户手册和操作 册中关于本项目功能、性能、实现环境等方面的描述是没有差别 的。

特别要避免在文档中出现转引其它文档内容的情况。

比如,一 些段落并未具体描述,而用 "见××文档××节 "的方式,这将给 读者带来许多不便。

⑤灵活性:各个不同的软件项目,其规模和复杂程度有着许 多实际差别,不能一律看待。

对于较小的或比较简单的项目,可做适当调整或合 并。

比如,可将用户手册和操作手册合并成用户操作手册;软件需 求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设 计说明书与详细设计说明书合并成软件设计说明书等。

⑥可追溯性;由于各开发阶段编制的文档与各阶段完成的工 作有着紧密的关系,前后两个阶段生成的文档,随着开发工作的逐步扩展,具有一定的继承关系。

在一个项目各开发阶段之间提供的文档必定存在着可追溯的关系。

例如,某一项软件需求,必定在设计说明书,测试计划以至用户手册中有所体现。

必要时应能做到 跟踪追查

hostodo:2021美国独立日7折优惠促销NVMe硬盘的VPS,低至$13/年,还送DirectAdmin授权

7月4日是美国独立日,大致就是国庆节的意思吧。hostodo今年提前搞了个VPS大促销活动,4款便宜VPS,相当于7折,续费不涨价,本次促销不定时,不知道有多少货,卖完为止。VPS基于KVM虚拟,NVMe阵列,1Gbps带宽,自带一个IPv4+/64 IPv6,solusvm管理,送收费版DirectAdmin授权,VPS在用就有效! 官方网站:https://www.hostodo.com ...

香港云服务器 1核 1G 29元/月 快云科技

快云科技: 12.12特惠推出全场VPS 7折购 续费同价 年付仅不到五折公司介绍:快云科技是成立于2020年的新进主机商,持有IDC/ICP等证件资质齐全主营产品有:香港弹性云服务器,美国vps和日本vps,香港物理机,国内高防物理机以及美国日本高防物理机产品特色:全配置均20M带宽,架构采用KVM虚拟化技术,全盘SSD硬盘,RAID10阵列, 国内回程三网CN2 GIA,平均延迟50ms以下。...

创梦网络-江苏宿迁BGP云服务器100G高防资源,全程ceph集群存储,安全可靠,数据有保证,防护真实,现在购买7折促销,续费同价!

官方网站:点击访问创梦网络宿迁BGP高防活动方案:机房CPU内存硬盘带宽IP防护流量原价活动价开通方式宿迁BGP4vCPU4G40G+50G20Mbps1个100G不限流量299元/月 209.3元/月点击自助购买成都电信优化线路8vCPU8G40G+50G20Mbps1个100G不限流量399元/月 279.3元/月点击自助购买成都电信优化线路8vCPU16G40G+50G2...

软件开发文档为你推荐
监控设备安装监控器怎么安装通话宝什么是来电宝?有什么用处?零终端银行卡圈存是什么意思封包是什么洛克王国封包是什么意思反恐精英维护到几点反恐精英几点维护完双11数据2015年天猫双11总成交额是多少亿?解码器有什么用监控解码器是指什么?上海网络维护公司上海有没有专业公司网络维护的啊最新汽车电子产品目前国内生产“汽车电子”(如:车载DVD、数字电视、个人电脑等车用电子产品)的企业有哪些?垂直型网站什么叫垂直媒体 哪些是垂直媒体
kdata 128m内存 60g硬盘 免费个人博客 ev证书 云图标 服务器架设 毫秒英文 789电视网 699美元 上海服务器 空间登录首页 东莞idc 百度云空间 网页加速 广东服务器托管 hdroad 腾讯服务器 塔式服务器 标准机柜 更多