软件项目开发函中文档的编制和管理.docVIP

软件项目开发中文档的编制和管理 文档是软件项目开发应用的一部分，存在于软件项目的整个生命周期之中，没有正式文档的软件项目开发，就不是规范标准的软件项目。文档Bug是软件缺陷的一种表现形式，通常客户并不知道文档是否存在Bug，如果按照带有缺陷的文档进行安装操作，同样会造成不良的后果，甚至带来损失，在实际工作中因文档质量不高，造成软件投产后出现系统宕机、账务扎账错误等生产问题时有发生。因此，文档的编制和管理在软件项目开发中占有突出的地位和相当大的工作量，高质量、高效率地设计、编制、分发、管理和维护文档，对于转让、变更、修正、扩充和使用文档，对于提高软件项目的质量和客户满意度有着重要的现实意义。 1.文档的涵义 软件项目中的文档是用来记录、描述、展示软件项目开发过程中一系列信息的处理过程，通过书面或图示的形式对软件项目整体活动过程或结果进行描述、定义、规定、报告及认证。它描述和规定了软件项目开发的每一个细节，使用软件的操作命令及软件产品投产以后，对产品使用过程中意见及产品缺陷、质量等方面的说明。 2.文档的作用 （1）提高了软件项目开发过程的能见度。标准规范、齐全的文档，详细记录了软件项目开发过程中发生的事件，便于项目管理人员检查、掌握软件开发进度、开发质量以及各种资源的调配，是开发人员进行软件开发的依据，也是项目成员协调工作的依据。 （2）提高了软件项目的开发效率。项目成员用一定时间编制、整理软件文档，可以使开发人员对各个阶段的工作都进行周密思考和理顺、找出存在的问题，从而减少差错，提高软件项目质量。同时，通过对完成文档的检查，在项目开发早期发现软件文档的错误和不一致性，加以及时纠正，可以减少文档Bug深入项目而导致的大问题的出现和为纠正这些错误而付出的更大的成本。 （3）便于软件项目成员之间的交流与合作。文档是一种无声的语言，它记录了软件项目开发过程中有关软件开发、运行、维护和培训等方面的信息，这些信息有利于管理人员、开发人员、操作人员、用户之间的交流和合作，便于软件项目能在规定的时间、费用内完成开发和投产应用。 （4）方便客户选购软件产品。描述清楚、完备的文档便于客户了解软件的功能、性能等各项指标，为客户选购符合自己需要的软件提供依据，是在客户与软件开发企业之间架起的一座桥梁。 （5）是做好软件项目投产维护工作的保证。高质量的文档可以帮助技术人员顺利完成软件的安装，并及时排除软件系统运行过程中出现的各种错误，可以帮助客户知道在使用操作过程中出现的错误信息含义，及时处理出现的问题并顺利完成工作。因此，高质量的文档是软件项目顺利投产的保障。 （6）有利于操作人员正确操作，减少操作失误。操作人员对产品的认识更多地是来自有关软件产品的使用说明文档，这些文档可以提高操作人员正确、快速地为客户办理业务的质量，做好产品的宣传，发挥产品性能，为客户提供周到细致的服务。 （7）有利于客户正确操作自助设备。描述简单、正确、清晰的文档，便于客户尽快地掌握ATM、POS、网上银行、手机银行及自助终端等各种自助设备的操作，方便客户，增强客户对金融产品的认知，提高自助设备的使用率和效益。 3.文档的分类 （1）开发文档：这类文档在软件项目开发过程中，体现了软件开发人员前一阶段工作的成果，同时又是后一阶段工作的依据。这类文档包括可行性研究报告、软件项目开发计划、软件需求规格说明、系统规格说明书、软件功能说明书和数据字典等。 （2）管理文档：这类文档在软件项目开发过程中，由软件开发人员制定的需提交管理部门的一些工作计划、工作方案和工作报告。通过阅读这些文档，管理人员能够了解软件项目开发活动安排、进度、资源使用等情况。这类文档包括项目开发计划、测试计划、测试方案、开发进度报告和项目总结报告等。 （3）用户文档：这类文档是软件开发人员为使用该软件的网点经办人员准备的有关该软件产品使用、操作的资料，主要是操作手册及新功能介绍方面的文档。 4）投产文档：这类文档主要是软件开发人员对数据中心、分行科技人员准备的有关投产说明、版本安装、软件测试等方面的资料。 （5）记录文档：与客户交流往来的记录、软件项目开发过程中各种会议、跟踪记录、审查记录、产品投产记录和问题跟踪解决记录等。 （6）反馈文档：这类文档主要是软件产品在推广使用以后，客户对产品使用过程中意见及产品缺陷、质量等方面的信息反馈。 4.文档常见问题 （1）文档编写不够规范。主要表现在软件项目实施过程中，没有对每一个阶段的文档进行整理，分层次管理，各类文档资料缺少一个可以参照的样本，更多的是在以前他人写好的基础上，对内容进行修改一下就算完成任务。 （2）文档内容描写不够完善。在编写各种文档过程中，虽然大家都按事先规定的模式进行了编