软件项目生命周期中的文档管理
文档是软件工程开辟使用的一全体，生存于软件工程的全部性命周期当中，不正式文档的软件工程开辟，就不是标准规范的软件工程。文档Bug是软件缺点的一种展现情势，一般客户其实不明白文档是不是生存Bug，假如依照带出缺陷的文档举行安置操控，一样会形成不良的前因，乃至带来丧失，正在实在职务中因文档品质不高，形成软件投产后显现体系宕机、账务扎账差错等临盆疑问时有产生。因而，文档的体例和治理正在软件工程开辟中占据显著的身份和十分大的职务量，高品质、有效率地策划、体例、散发、治理和保护文档，关于让渡、变动、修改、扩大和利用文档，关于普及软件工程的品质和客户中意度有侧重要的事实含义。
1.文档的涵义
软件工程中的文档是用来纪录、形容、展现软件工程开辟历程中一系列资讯的处置历程，经由过程书面或图示的情势对软件工程全体行动历程或结实举行形容、界说、划定、汇报及认证。它形容和划定了软件工程开辟的每个细节，利用软件的操控指令及软件产物投产之后，对产物利用历程满意见及产物缺点、品质等方面的阐明。
2.文档的效用
（1）普及了软件工程开辟历程的能见度。规范标准、完备的文档，具体纪录了软件工程开辟历程中产生的事故，便于工程治理职员反省、把握软件开辟进展、开辟品质和各类物资的分配，是开辟职员举行软件开辟的根据，也是工程成员和谐职务的根据。
（2）普及了软件工程的开辟效力。工程成员用必定时辰体例、归纳软件文档，能够使开辟职员对各个阶段的职务都举行严密思索和理顺、找出生存的疑问，从而缩减不对，普及软件工程品质。同时，经由过程对完毕文档的反省，正在工程开辟初期发觉软件文档的差错和纷歧致性，加和时改正，能够缩减文档Bug深刻工程而招致的大疑问的显现和为改正这些差错而奉献的更大的费用。
（3）便于软件工程成员之间的交换与协作。文档是一种寂声的言语，它纪录了软件工程开辟历程中相关软件开辟、运转、保护和培养等方面的资讯，这些资讯无利于治理职员、开辟职员、操控职员、用户之间的交换和协作，便于软件工程能正在划定的时辰、用度内完毕开辟和投产使用。
（4）不便客户选购软件产物。形容清晰、齐全的文档便于客户知晓软件的作用、效能等各项目标，为客户选购切合本人必要的软件供应根据，是正在客户与软件开辟公司之间架起的一所桥。
（5）是做好软件工程投产保护职务的保障。高品质的文档能够协助手艺职员顺畅完毕软件的安置，并适时扫除软件体系运转历程中显现的各类差错，能够协助客户明白正在利用操控历程中显现的差错资讯含意，适时处置显现的疑问并顺畅完毕职务。因而，高品质的文档是软件工程顺畅投产的保证。
（6）无利于操控职员准确操控，缩减操控失误。操控职员对产物的认知更多地是来自相关软件产物的利用阐明文档，这些文档能够普及操控职员准确、迅速地为客户打点营业的品质，做好产物的宣扬，发扬产物效能，为客户供应周密精细的服侍。
（7）无利于客户准确操控自助设施。形容简易、准确、清楚的文档，便于客户尽快地把握ATM、POS、网上金融机构、移动电话金融机构及自助终端等各类自助设施的操控，不便客户，加强客户对财经产物的认识，普及自助设施的利用率和效益。
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.利用器具治理文档
关于一个大型的软件工程体系，从构成观念起始，经由策划、开辟、宣扬利用和持续补充订正，直到后被减少的全部工程性命周期中都要著述大批的文档。而文档著述的内容是正在持续变革的，有的是一连的，承上启下的，有的是新增多的，也有的是取销的，怎样治理好这些文档材料，为众人供应新的资讯，便于平日的挪用查问，便于资讯的使用，是发扬文档效用的紧要一环，不然便是占用空地的渣滓。这就必要策划开辟一个一致的软件文档治理器具，分门别类一致寄存治理各类文档材料，创建软件文档材料资讯库，供众人随时随刻查问挪用。
总之，文档正在软件工程的开辟历程中起到了闭键的效用，从某种含义下去说，文档是软件工程开辟标准的表现和指南，依照标准需求体例一整套文档的历程，便是依照开辟标准完毕一个软件工程开辟的历程。高品质的文档能够普及软件工程的品质，有助于步骤员体例步骤，有助于治理职员监视和治理软件的开辟，有助于用户更好地安置和利用软件体系，有助于保护职员举行无效的修正和扩大。以是，正在软件工程的开辟历程中，要充实做好软件文档的体例和治理职务。
1.文档的涵义
软件工程中的文档是用来纪录、形容、展现软件工程开辟历程中一系列资讯的处置历程，经由过程书面或图示的情势对软件工程全体行动历程或结实举行形容、界说、划定、汇报及认证。它形容和划定了软件工程开辟的每个细节，利用软件的操控指令及软件产物投产之后，对产物利用历程满意见及产物缺点、品质等方面的阐明。
2.文档的效用
（1）普及了软件工程开辟历程的能见度。规范标准、完备的文档，具体纪录了软件工程开辟历程中产生的事故，便于工程治理职员反省、把握软件开辟进展、开辟品质和各类物资的分配，是开辟职员举行软件开辟的根据，也是工程成员和谐职务的根据。
（2）普及了软件工程的开辟效力。工程成员用必定时辰体例、归纳软件文档，能够使开辟职员对各个阶段的职务都举行严密思索和理顺、找出生存的疑问，从而缩减不对，普及软件工程品质。同时，经由过程对完毕文档的反省，正在工程开辟初期发觉软件文档的差错和纷歧致性，加和时改正，能够缩减文档Bug深刻工程而招致的大疑问的显现和为改正这些差错而奉献的更大的费用。
（3）便于软件工程成员之间的交换与协作。文档是一种寂声的言语，它纪录了软件工程开辟历程中相关软件开辟、运转、保护和培养等方面的资讯，这些资讯无利于治理职员、开辟职员、操控职员、用户之间的交换和协作，便于软件工程能正在划定的时辰、用度内完毕开辟和投产使用。
（4）不便客户选购软件产物。形容清晰、齐全的文档便于客户知晓软件的作用、效能等各项目标，为客户选购切合本人必要的软件供应根据，是正在客户与软件开辟公司之间架起的一所桥。
（5）是做好软件工程投产保护职务的保障。高品质的文档能够协助手艺职员顺畅完毕软件的安置，并适时扫除软件体系运转历程中显现的各类差错，能够协助客户明白正在利用操控历程中显现的差错资讯含意，适时处置显现的疑问并顺畅完毕职务。因而，高品质的文档是软件工程顺畅投产的保证。
（6）无利于操控职员准确操控，缩减操控失误。操控职员对产物的认知更多地是来自相关软件产物的利用阐明文档，这些文档能够普及操控职员准确、迅速地为客户打点营业的品质，做好产物的宣扬，发扬产物效能，为客户供应周密精细的服侍。
（7）无利于客户准确操控自助设施。形容简易、准确、清楚的文档，便于客户尽快地把握ATM、POS、网上金融机构、移动电话金融机构及自助终端等各类自助设施的操控，不便客户，加强客户对财经产物的认识，普及自助设施的利用率和效益。
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.利用器具治理文档
关于一个大型的软件工程体系，从构成观念起始，经由策划、开辟、宣扬利用和持续补充订正，直到后被减少的全部工程性命周期中都要著述大批的文档。而文档著述的内容是正在持续变革的，有的是一连的，承上启下的，有的是新增多的，也有的是取销的，怎样治理好这些文档材料，为众人供应新的资讯，便于平日的挪用查问，便于资讯的使用，是发扬文档效用的紧要一环，不然便是占用空地的渣滓。这就必要策划开辟一个一致的软件文档治理器具，分门别类一致寄存治理各类文档材料，创建软件文档材料资讯库，供众人随时随刻查问挪用。
总之，文档正在软件工程的开辟历程中起到了闭键的效用，从某种含义下去说，文档是软件工程开辟标准的表现和指南，依照标准需求体例一整套文档的历程，便是依照开辟标准完毕一个软件工程开辟的历程。高品质的文档能够普及软件工程的品质，有助于步骤员体例步骤，有助于治理职员监视和治理软件的开辟，有助于用户更好地安置和利用软件体系，有助于保护职员举行无效的修正和扩大。以是，正在软件工程的开辟历程中，要充实做好软件文档的体例和治理职务。
- 上一篇：吕必松的《对外汉语教学概论讲义》三
- 下一篇：返回列表