造成软件开发文档质量不高的原因有什么-临沂软件开发
造成软件开发文档质量不高的原因可能是:缺乏实践经验,缺乏评价软件开发文档质量的标准。不重视临沂软件开发文档编写工作或是对软件开发文档编写工作的安排不恰当。
最常见到的情况是,软件开发过程中不能按给出的进度,分阶段及时完成软件开发文档的编制工作,而是在开发工作接近完成时集中人力和时间专门编写软件开发文档。另一方面,和程序工作相比,许多人对编制软件开发文档不感兴趣。于是在程序工作完成以后,不得不应付一下,把要求提供的软件开发文档赶写出来。这样的做法不可能得到高质量的软件开发文档。实际上,要得到真正高质量的软件开发文档并不容易,除去应在认识上对软件开发文档工作给予足够的重视外,常常需要经过编写初稿,听取意见进行修改,甚至要经过重新改写的过程。
高质量的软件开发文档应当体现在以下一些方面:
①针对性。
临沂软件开发文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。例如,管理软件开发文档主要是面向管理人员的,用户软件开发文档主要是面向用户的,这两类软件开发文档不应像开发软件开发文档(面向软件开发人员)那样过多地使用软件的专业术语。
②精确性。
软件开发文档的行文应当十分确切,不能出现多义性的描述。同一课题若干软件开发文档内容应该协调一致,应是没矛盾的。
③清晰性。
软件开发文档编写应力求简明,如有可能,配以适当的图表,以增强其清晰性。
④完整性。
任何一个软件开发文档都应当是完整的、独立的,它应自成体系。例如,前言部分应作一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。同一课题的几个软件开发文档之间可能有些部分相同,这些重复是必要的。例如,同一项目的用户手册和操作册中关于本项目功能、性能、实现环境等方面的描述是没有差别的。特别要避免在软件开发文档中出现转引其它软件开发文档内容的情况。比如,一些段落并未具体描述,而用"见××软件开发文档××节"的方式,这将给读者带来许多不便。
⑤灵活性。
各个不同的软件项目,其规模和复杂程度有着许多实际差别,不能一律看待。图6所列软件开发文档是针对中等规模的软件而言的。对于较小的或比较简单的项目,可做适当调整或合并。比如,可将用户手册和操作手册合并成用户操作手册;软件需求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设计说明书与详细设计说明书合并成软件设计说明书等。
⑥可追溯性。
由于各开发阶段编制的软件开发文档与各阶段完成的工作有着紧密的关系,前后两个阶段生成的软件开发文档,随着开发工作的逐步扩展,具有一定的继承关系。在一个项目各开发阶段之间提供软件开发文档必定存在着可追溯的关系。例如,某一项软件需求,必定在设计说明书,测试计划以至用户手册中有所体现。必要时应能做到跟踪追查。
最常见到的情况是,软件开发过程中不能按给出的进度,分阶段及时完成软件开发文档的编制工作,而是在开发工作接近完成时集中人力和时间专门编写软件开发文档。另一方面,和程序工作相比,许多人对编制软件开发文档不感兴趣。于是在程序工作完成以后,不得不应付一下,把要求提供的软件开发文档赶写出来。这样的做法不可能得到高质量的软件开发文档。实际上,要得到真正高质量的软件开发文档并不容易,除去应在认识上对软件开发文档工作给予足够的重视外,常常需要经过编写初稿,听取意见进行修改,甚至要经过重新改写的过程。
高质量的软件开发文档应当体现在以下一些方面:
①针对性。
临沂软件开发文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。例如,管理软件开发文档主要是面向管理人员的,用户软件开发文档主要是面向用户的,这两类软件开发文档不应像开发软件开发文档(面向软件开发人员)那样过多地使用软件的专业术语。
②精确性。
软件开发文档的行文应当十分确切,不能出现多义性的描述。同一课题若干软件开发文档内容应该协调一致,应是没矛盾的。
③清晰性。
软件开发文档编写应力求简明,如有可能,配以适当的图表,以增强其清晰性。
④完整性。
任何一个软件开发文档都应当是完整的、独立的,它应自成体系。例如,前言部分应作一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。同一课题的几个软件开发文档之间可能有些部分相同,这些重复是必要的。例如,同一项目的用户手册和操作册中关于本项目功能、性能、实现环境等方面的描述是没有差别的。特别要避免在软件开发文档中出现转引其它软件开发文档内容的情况。比如,一些段落并未具体描述,而用"见××软件开发文档××节"的方式,这将给读者带来许多不便。
⑤灵活性。
各个不同的软件项目,其规模和复杂程度有着许多实际差别,不能一律看待。图6所列软件开发文档是针对中等规模的软件而言的。对于较小的或比较简单的项目,可做适当调整或合并。比如,可将用户手册和操作手册合并成用户操作手册;软件需求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设计说明书与详细设计说明书合并成软件设计说明书等。
⑥可追溯性。
由于各开发阶段编制的软件开发文档与各阶段完成的工作有着紧密的关系,前后两个阶段生成的软件开发文档,随着开发工作的逐步扩展,具有一定的继承关系。在一个项目各开发阶段之间提供软件开发文档必定存在着可追溯的关系。例如,某一项软件需求,必定在设计说明书,测试计划以至用户手册中有所体现。必要时应能做到跟踪追查。
想要了解更多详情欢迎来电咨询18678812288,或登陆网址www.rzydkj.com。联系人:王经理。
成功案例
-
日照、临沂智慧井盖_污水井盖智能
-
日照、临沂检察机关检察人员分类
-
日照交规速成系统|临沂交规考试平
-
检察院网络服务大厅软件平台
-
企业在线考试系统
-
党员在线考试系统
-
赢德P2P网贷系统
-
日照心理测评软件|临沂心理测评系
-
日照内部培训管理系统|临沂出国留
-
日照物流软件开发|临沂快递软件开
-
狠刹“四风”网络监督平台软件
-
党员领导干部德廉知识在线学习测
-
日照在线考试系统|临沂在线考试软
-
菏泽新巨龙煤矿采掘资料达标管理
-
科技信息评价信息系统
-
绩效考核系统
-
济钢炼铁厂管理信息系统
-
国税房产企业所得税监控管理系统
-
人力资源管理信息系统
-
三维数字矿山信息系统
-
展屏系统
-
洁能建筑智能管理终端系统
-
汽修厂管理系统