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

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

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

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

这样你就可以考考他啊!

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

必要时应能做到 跟踪追查

bluehost32元/月,2核2G/20GB空间,独立ip,新一代VPS美国云主机!

bluehost怎么样?bluehost推出新一代VPS美国云主机!前几天,BlueHost也推出了对应的周年庆活动,全场海外虚拟主机月付2.95美元起,年付送免费的域名和SSL证书,通过活动进入BlueHost中文官网,购买虚拟主机、云虚拟主机和独立服务器参与限时促销。今天,云服务器网(yuntue.com)小编给大家介绍的是新一代VPS美国云主机,美国SSD云主机,2核2G/20GB空间,独立...

青云互联-洛杉矶CN2弹性云限时五折,9.5元/月起,三网CN2gia回程,可选Windows,可自定义配置

官方网站:点击访问青云互联官网优惠码:五折优惠码:5LHbEhaS (一次性五折,可月付、季付、半年付、年付)活动方案:的套餐分为大带宽限流和小带宽不限流两种套餐,全部为KVM虚拟架构,而且配置都可以弹性设置1、洛杉矶cera机房三网回程cn2gia 洛杉矶cera机房                ...

[黑五]ProfitServer新加坡/德国/荷兰/西班牙VPS五折,不限流量KVM月付2.88美元起

ProfitServer已开启了黑色星期五的促销活动,一直到本月底,商家新加坡、荷兰、德国和西班牙机房VPS直接5折,无码直购最低每月2.88美元起,不限制流量,提供IPv4+IPv6。这是一家始于2003年的俄罗斯主机商,提供虚拟主机、VPS、独立服务器、SSL证书、域名等产品,可选数据中心包括俄罗斯、法国、荷兰、美国、新加坡、拉脱维亚、捷克、保加利亚等多个国家和地区。我们随便以一个数据中心为例...

软件开发文档为你推荐
动画技术影视动画专业是干什么的?距离查询如何查询公路里程网络地址分类网络地址划分,急,双11数据2015年天猫双11总成交额是多少亿?人工电源网络设备EMC试验等级怎么选择?有选择标准吗?是什么标准?谢谢!怎样清除历史记录怎样清除历史记录阿里学院首页阿里学院成都站--让成都电子商务的发展势如破竹mysql数据库迁移怎样用命令行把MySQL数据库迁移到另一台Linux服务器externc++ vc++ 中的 extern 是什么意思,具体的用法系统修复系统修复故障是什么
asp主机 国内最好的虚拟主机 万网虚拟主机 jsp虚拟主机 域名空间购买 广东vps 东莞电信局 oneasiahost 美国主机论坛 老左博客 哈喽图床 sub-process seovip info域名 铁通流量查询 可外链网盘 免费测手机号 电信虚拟主机 hktv metalink 更多