浅谈小型企业软件项目文档管理.doc

浅谈小型企业软件项目文档管理 关键词：文档管理 模版管理 目录管理 命名规范 变更管理论文摘要：对于小型企业而言，由于业务量小或业务单一，软件项目的研发往往采用自行开发手段或与开发人员合作共同开发的方式，在软件开发过程中，随意性较大，缺乏规范管理，特别是对文档管理的忽视，常常给项目的实施和维护带来诸多困难。小型企业的软件项目应重视项目的文档管理，保证系统能够正常安装、使用，方便日后的维护。对于小型企业的软件项目，是否应严格按照软件文档管理的规定进行文档管理呢?笔者认为，软件项目中的文档一定要有的，但不一定要多，能够保证系统的正常安装、使用，方便日后的维护就可以了。1项目文档的萤要性文档是软件项目开发应用的一部分，存在于软件项目的整个生命周期之巾，没有正式文档的软件项目开发，就不是标准规范的软件项目。文档Bug是软件缺陷的一种表现形式，通常客户并不知道文档是否存在Bug，如果按照带有缺陷的文档进行安装操作，同样会造成不良的后果，甚至带来损失，在实际工作中因文档质量不高，造成软件投产后出现系统宕机、延误生产的问题时有发生。因此，文档的编制和管理在软件项目开发中占有突出的地位和相当大的工作量，高质量、高效率地设计、编制、分发、管理和维护文档，对于转让、变更、修正、扩充和使用文档，对于提高软件项目的质量和客户满意度有着重要的现实意义。2文档管理的方式在项目实施过程中，由于项目实施的复杂性，多方人员参加以及时间跨度长等因素，所以有关需求、建议、解决方案和会议、问题记录等都必须文档化、标准化，以便查阅和引用。这些文档伴随着项目实施的各个阶段逐渐充实、完善；与此同时，它们亦记载跟踪了整个实施的过程和成果。因此，在文档管理的过程中，需要把握住一些重要的原则和方法，这样可以让我们的文档真正达到预期的目的。21文档模板的管理面对项目中需要建立的各类纷繁复杂的文档，如果各式各样，每个人一个风格，不论从美观性和可读性上都会有影响，所以在文档管理中的过程中应建立一套文档的模板。在建立文档模板时，需要对一些格式进行要求，需要将一些基本的要素固化到文档模板中，确保文档需要的内容能够在文档中体现，例如文档的页眉页脚、文档变更历史、文档的目录方式、文档的字体等。在建立文档时，要注意做好文档的分类，各种分类有一个清晰的定义，使用者可以清楚地知道实际使用时要采用哪种模板。如果是使用共享目录方式管理文档，需要在一个相对容易找到的文件夹目录中存放模板，如果是使用信息系统方式进行模板管理，最好能够在首页进行一个链接，让使用者可以快速的搜索到。在建立分类时，需要含有一个共同类，或者叫做公用类，因为在实际的使用过程中总是会有一些新的类别出现，也会有一些无法进行分类的文档，这个时候就可以通过共同类进行管理。 对于文档模板的变更需要能够做到及时告知使用者，并做好版本管理。2_2文档目录的管理为了能够在纷繁复杂的文档中找到需要的文档，需要在进行文档管理时建立一套完整的文档目录体系，主要包括文档的索引管理和文档的分类管理。在进行文档管理前，需要对不同的文档建立一个分类，建议不同的分类可以便于文档的查找，也可以针对不同的分类制定不同的管理要求。如果是文件夹方式管理，还需要分别不同的文件夹内容的安排以及权限的控制，因为文件夹管理的特殊性，需要注意其权限管理的简洁化；如果是采用信息系统管理，需要注意类型的编码体系的建立。一个好的文档分类体系可以让使用者方便地进行文档的归类和查找，文档的分类在一些管理过程中还需要注意归档管理的需求。对于文档，需要建立一套索引机制，这里之所以特别提出索引机制，是因为在日常的文档使用中，会发现一些很多类似的文档，或者类似的内容说明，由于不同的撰写者会对一些基本的概念或者原则的说明会存在一些差异，这个时候就需要能够有一个索引来明确什么是最准确的，这一点在项目管理过程中特别重要，因为一个项目组往往会不时的发生一些变动，后来人面对多个说法时很难知道什么足对的，同时一些实际情况也会发生变动，一些说法也需要进行修正，而之前的一些文档也无法进行更正，所以这个时候也需要有一个索引来明确正确的说法，这一点问题也可以通过文档版本的管理加以改善。2_3文档的命名规范各种文档，如果名称多样，或者名称含义模糊将会造成使用和交流上的不便需要建立一套有效的命名规范体系。对于文档的名称，首先需要名称能够容易识别，有些使用者不是很注意文档的名称，经常直接用文件的默认名称，或者就是一个自己的姓名、项目的名称等，其他的使用者很难识别是什么类型的文档。在文档的使用过程中，可以规定在文档的某些部位必须放置文档的类型或者某些其他关键宁，例如将求将文档的类别放在文件名的头部，对于月度性的文档，规定头部必须放某年某月，等等。对于一些分不同版本的文档，可以要求分不同的版本进行管理，文件名称中注明版本号，刘于终稿等一些标志性的内容可以加一些特殊的标识，这样可以明确其重要性和权威性。这些方式将有助于文档的文件名的整洁和清晰，使用者在找时也较为方便。在进行文档的交互调整过程中，也可以增加一些13期或者修改者的标识来进行传递，主要的同的在于能够唯一识别一个文档，减少互相沟通的障碍。 2-4文档的变更管理文档在使用过程中发生变更是很常见的现象，对于发生变更的文档，需要通过手段加以约束，最常用的方法就是版本的管理，对于形成的文档及时进行归档保存。文档发生变更时，需要能够做到两点：第一，文档有清晰的变更记录，主要是针对变化的部分。不能让每个使用者在文档发生变化后都需要把文件通篇读一遍；第二，文档的最终版本要能方便的阅览，如果出现只能看变更历史才知道最终版本的话将大大提高使用成本在文档发生变更时，需要能够通过必要的途径通知相关人，例如通过邮件通知或者公告通知的方式，避免新的文档产生后还有大量的使用者使用旧的文档，在实际操作环境中IS09000管理使用的签字回收重要文档的方式很值得借鉴，当然对一些电子文档需要采用一些其他变通的方式来处理。25文档的审核制度很多文档作为一种指导性文件，需要有一定的严肃性和权威性，因而对文档进行必要的审核是必须的。文档的审核时机一般为文档建立时和文档发生变更时，对于文档的适用范围的变更也应该进行必要的审核。通过文档的审核，可以检查是否存在错误的事项或者一些不合理的事项，撰写者和审核者所处的岗位不同、知识结构不同，对于一个文档如何撰写的角度和看法也会不同，在后续的审核过程中能够很好的进行文档的校正。同时，文档的审核机制也可以明确各自岗位的责任。总之，信息系统的实施是一个负责的管理过程，需要方方面面的管理工作配合到位。文档在软件项目的开发过程中起到了关键的作用，文档作为一种日常交流的重要依据和工作成果的总结显得尤为重要，从某种意义上来说，文档是软件项目开发规范的体现和指南按照规范要求编制一整套文档的过程，就是按照开发规范完成一个软件项目开发的过程。高质量的文档可以提高软件项目的质量，有助于程序员编制程序，有助于管理人员监