软件项目管理文档的作用
来源:广州软件开发 编辑:广州软件开发公司 日期:2020-03-20
文档是软件项目开发运用的一部分,存在于软件项意图整个生命周期之中,没有正式文档的软件项目开发,就不是标准
标准的软件项目。文档Bug是软件缺陷的-种表现方式,一般妒并不知道文档是否存在Bug,假如依照带有缺陷的文档进
行装置操作,同样会形成不良的成果,甚至带来秩,在实践作业中因文档质量不高,形成软件投产后呈现体系宕机、账务
扎账过错等生产问题时有发作。因而,文档的编制和处理在软件项目开发中占有杰出的位置和相当大的作业量,质量高
功率地规划、编制、分发、处理和保护文档,关于转让、变更、修正、扩大和运用文档,关于进步软件项意图质量和客户
满意度有着重要的现实意义。
1.文档的涵义
软件项目中的文档用来记载、描绘、示软件项目开发进程中一系列信息的处理进程,过书面或
际的方式对软件项目全体活动进程或成果进行描绘、义规则、陈述及认证。它描绘和规则了软件项
盱发的每一个细节,运用软件的操作指令及软件产品投产以诟,对产品运用进程中定见及产品缺陷、质
等方面的阐明。
项目处理者联盟文章,深入探讨。
2.文档的效果
(1)进步了软件项目开发进程的能见度。标准标准、齐拴的文档,具体记载了软件项目开发进程中
发作的事件,便于项目处理人员查看、把握软件开发进度、开发质量以及各种资源的分配,开发人员进
行软件开发的依据,也是项目成员协调作业的依据。
(2)进步了软件项意图开发功率。项目成员用一定时刻编制、收拾软件文档,能够使开发人员对各
个阶段的作业都进行缜密考虑和理顺、找出存在的问题,然后削减过失,进步软件项目量。一起,过
对完结文档的查看,项目开发前期发现软件文档的过错和不-致性,加以及时纠征,能够削减文档Bug
深入项目导致的大问题的呈现和为纠正这些过错而付出的更大的本钱。
(3)便于软件项目成员之间的沟通与合作。文档是-种无声的言语,它记载了软件项目开发进程中
有关软件开发、运转、保护和培训等方面的信息,这些信息有利于理人员、开发人员、操作人员、胪
之间的沟通和合作,便于软件项目能在规则的时刻、费用内完结开发和投产运用。
(4)便利客户选购软件产品。描绘清楚、完备的文档便于客户了解软件的功用性能等各项指标,
为客户选购契合自己需要的软件供给依据,在客户与软件开发企业之间架起的--座桥梁。
(5)是做好软件项目投产保护作业的保证。质量的文档能够协助技术人员顺利完结软件的装置,
并及时排除软件体系运转进程中呈现的各种过错,能够协助客户知道在运用操作进程中呈现的过错信息含
义,及时处理呈现的问题并顺利完结作业。因而,质量的文档是软件项目顺利投产的保证。
(6)有利于操作人员正确操作,削减操作失误。操作人员对产品的认识更多地是来自有关软件产品
的运用阐明文档,这些文档能够进步操作人员正确、快速地为客户处理事务的质量,做好产品的宣扬,发
挥产品性能,为客户供给周到细致的服务。
(7)有利于客户正确操作自助设备。描绘简略、正确、明晰的文档,便于客户尽快地把握ATM、PO
S、网上银行、手机银行及自助终端等各种自助设备的操作,便利客户,增强客户对金融产品的认知,提
自助设备的运用率和效益。
3.文档的分类
(1)开发文档:这类文档在软件项目开发进程中,表现了软件开发人员前一阶段作业的效果,一起
又后一阶段作业的依据。这类文档包含可行性研究陈述、软件项目开发计划、软件需求规格阐明、統
规格阐明书、软件功用阐明书和数据字典等。
(2)处理文档:这类文档在软件项目开发进程中,由软件开发人员拟定的需提交处理部门的一些红
作计划、作业计划和作业陈述。通过阅览这些文档,处理人员能够了解软件项目开发活动安排、进度资
源运用等情况。这类文档包含项目开发计划、测验计划、测验计划、开发进度陈述和项目总结陈述等。
(3)胪文档:这类文档是软件开发人员为运用该软件的网点经助人员预备的有关该软件产品使
用、操作的材料,主要是操作手册及新功用介绍纺面的文档。
(4)投产文档:这类文档主要是软件开发人员对数据中心、分行科技人员预备的有关投产阐明、版别安
装软件测验等方面的材料。
(5)录文档:与客户沟通往来的记载软件项目开发进程中各种会议、盯梢记载查记绿产
品投产记载和问题盯梢解决记载等。
(6)反应文档:这类文档主要是软件产品在推行运用今后,户对产品运用进程中定见及产品缺
陷、质等方面的信息反应。
4.文档常见问题
(1)文档编写不行标准。要表现在软件项目实施进程中,没有对每一个阶段的文档进行收拾,分
款处理,各类文档材料短少个能够参照的样本,更多的是在曾经他人写好的基础上,对内容进行修正
一下就算完结任务。
(2)文档内容描绘不行完善。在编写各种文档进程中,虽然我们都按事前规则的方式进行了编写,
但编写的内容经常不行完善,夹杂着-些旧的东西没有及时更新。特别是一些参数表、胪手册等些軸
数据中心、分行运用的文档,于时的疏漏,形成软件项目投产失利、投产后形成体系宕机、现账务
过失、客户依照你的操作阐明不能得到正确的成果等现象的发作。
(3)对文档评定不行,运用效果不理想。依照软件工程的要求,在软件项意图开发进程中从规划到
投产,要编写-列的文档,编写这些文档是有必要的,但经常会呈现这样的现象,在软件开发企业,某职
能部门]担任人员自行拟定了文档模板后,就知各部]进行运用,成果我们反映效果不好,剖析原因是没
有在编写时很好地依据企业自身的现状,从实践出发征求我们的定见,对投入运用的文档没有组织相关人
员进行评定。
(4)注重文档的方式,实用性不强。在实践的软件开发进程中,要求编制的文档十分侈,但编制人
没有时刻去关心它们的用处,也不知道哪些部]运用,更多的是在规则的时刻内完结任务,以晚影响考
核成绩,这样-来-些不实用的、复的文档编制作业,了开发人员有用的规划开发时刻,影响了项.
意图全体进度。因而,软件文档的拟定要实用,削减繁文缛节的文字作业。
(5)文档没有统-入库处理。跟着体系的不断优化、升级,新需求的不断产生,各种文档越来越
多,没有建立-个文档材料信息库,统-寄存软件项目不一起期的各种文档,零星存在的文档,形成查
询计算_个软件项日完好的文档信息时非堂困难
(6)对文档的编制注重不行。我们常常把文档作为软件产品的附件,对待文档材料没有像对待程序
代码-样关注和投入,文档中普遍存在错别字语句涵义表达不清楚,口语化稠密,引用的图表不行准
确,主题表达不行明晰等现象。
(7)对文档的测验不足。一般测验主要是针对软件项目功用的测验,对该软件项意图文档测验则很
少进行。一般用户把文档当成了软件产品的一部分,在软件产品装置运用进程中,不正确的提示信息把客
户引入途,不但得不到预期的成果,还会产生过错,给用户带来费事。
5.文档编制要求
(1)标准化:从需求剖析开端到投产运用所有触及的每-种文档,都要给出一-个能够执行的模板,
所有完结的文档从里到外都要十分整齐,具有专业水准,契合ISO9000及CMM质量标准要求。
(2)易用性:编制的各种软件文档,要便于不同的岗位人员进行阅览、理解、学习和运用。
(3)简洁性:要求软件项目中需要编写的文档内容杰出主题,贩映要描绘的问题,不包含其他不
必要的东西,言语表达简明扼要,-清二楚,如有或许,能够配以适当的图表,以增强其明晰性。
(4)针对性:文档要按不同的类型、面对不同的对象,实施差异化编制,依据实践需要进行编写,也就
是说文档编写意图要清晰,因需而变。例如处理文档主要面向处理人员,胪文档主要面向户,这两类
文档不该像开发文档(面响开发人员那样过多运用软件的专用术语。本文转自项目处理者联盟
项目处理者联盟文章,深入探讨。
(5)-致性:文档的行文应当十分切当,关于同一现像的描绘,不能呈现多义性的描绘,同-项相
帆个文档描绘的内容应是一致的,相仗间没有对立。
(6)完好性:任何一个文档都应当是完好的、独立的,没有遗失和丢失的内容。也便是说每一种文
档在规划时能够包含必要的图形、模型、叙说、表引附录和参考文献,列举的这些内容都完好
的。同一软件项目涉汲的几个文档之间或许存在部分内容相同,这种重蝮必要的,不要在文档中呈现"
见XX文档XX章节"的现象。
(7)灵活性:在实践操作中要针对软件项目规模和复杂程度的不同,对现行的文档进行修正,决綻
编制的文档品种。能够依据自身软件开发情况,拟定-个对文档编制的规则,列表的方式列出在项目什
么条件下,应该影成哪些文档,这些文档的具体程度。本文转自项目处理者联盟
(8)可追溯性:在软件项意图开发进程中,各个阶段编制的文档不是孤立的,而是与骆个阶段完结
的作业有密切的关系,跟着项目开发作业的发展,賄-定的继承关系,表现出了可追溯的特性,如软件
需球会在规划阐明书、测验规划方级胪手册中有所表现。
(9)设淀优先级:在软件项目很多的文档中,中-些纹档必定是要害文档,起到十分重要的作
用。关于这类文档要设定优先等级特别关注,不能有任何的过错存在,关于要害的地方要特别符号,
特别阐明。
6.文档的审阅
审阅便是查看编写的项目文档是否完全有无遗失,否契合文档的标准要求,内容描绘是否正确紧扣
主题,列出的图表信息是否准确,以保证文档的质量。审阅要花费-定的人力和时刻,但效果是显著的。
通过对文档进行全面的审阅、分的测验,有用地发现文档中存在的问题,如遗失的需求、剩余的功用设
计内容、不切实践的测验计划、可行的测验计划不充分的测验案例和不合格的操作手册等,提前发现
问题、改正问题。这样比客户运用软件时遇到费事或软件项目推行应中呈现问题时再向项目开发人寻
支持更有用,且能进步客户的满意度,削减犯错返工的本钱和时刻。
7.运用东西处理文档
关于个大型的软件项目统,从形成概念开端,经过规划、发、推行运用和不断增补修订,直到
后被筛选的整个项目生命周期中都要编写大量的文档。文档编写的内容是在不断变化的,有的是接连
的,承上启下的,有的是新增加的,也有的是废除的,如何处理好这些文档材料,为我们供给最新的信
息,便于日常的调用查询,便于信息的运用,是发挥文档效果的重要一环,则便是空间的废物。这
就需要规划开发一个统-的软件文档处理东西,分门别类统-寄存处理各种文档材料,建立软件文档材料
信息库,供我们随时查询调用。
总之,文档在软件项意图开发进程中起到了要害的效果,从某种意义上来说,文档是软件项目开发规
范的表现和攻略,依照标准要求编制一整套文档的进程,便是依照开发标准完结一个软件项目开发的过
程。质的文档能够进步软件项意图质量,有助于程序员编制程序,有助于处理人员监督和处理软件的
开发,有助于用户更好地装置和运用软件体系,有助于保护人员进行有用的修正和扩大。所以,在软件项
意图开发进程中,要充分做好软件文档的编制和处理作业。
想更详细了解,告诉我们您的具体需求,就可以获取一份专业的报价哦!广州山海软件定制开发官网:www.sunseam.com
相关阅读