论文关键词:文档管理 模版管理 目录管理 命名规范 变更管理
论文摘要:对于小型企业而言,由于业务量小或业务单一,软件项目的研发往往采用自行开发手段或与开发人员合作共同开发的方式,在软件开发过程中,随意性较大,缺乏规范管理,特别是对文档管理的忽视,常常给项目的实施和维护带来诸多困难。小型企业的软件项目应重视项目的文档管理,保证系统能够正常安装、使用,方便日后的维护。
对于小型企业的软件项目,是否应严格按照软件文档管理的规定进行文档管理呢?笔者认为,软件项目中的文档一定要有的,但不一定要多,能够保证系统的正常安装、使用,方便日后的维护就可以了。
1项目文档的萤要性
文档是软件项目开发应用的一部分,存在于软件项目的整个生命周期之巾,没有正式文档的软件项目开发,就不是标准规范的软件项目。文档Bug是软件缺陷的一种表现形式,通常客户并不知道文档是否存在Bug,如果按照带有缺陷的文档进行安装操作,同样会造成不良的后果,甚至带来损失,在实际工作中因文档质量不高,造成软件投产后出现系统宕机、延误生产的问题时有发生。因此,文档的编制和管理在软件项目开发中占有突出的地位和相当大的工作量,高质量、高效率地设计、编制、分发、管理和维护文档,对于转让、变更、修正、扩充和使用文档,对于提高软件项目的质量和客户满意度有着重要的现实意义。
2文档管理的方式
在项目实施过程中,由于项目实施的复杂性,多方人员参加以及时间跨度长等因素,所以有关需求、建议、解决方案和会议、问题记录等都必须文档化、标准化,以便查阅和引用。这些文档伴随着项目实施的各个阶段逐渐充实、完善;与此同时,它们亦记载跟踪了整个实施的过程和成果。因此,在文档管理的过程中,需要把握住一些重要的原则和方法,这样可以让我们的文档真正达到预期的目的。
2.1文档模板的管理
面对项目中需要建立的各类纷繁复杂的文档,如果各式各样,每个人一个风格,不论从美观性和可读性上都会有影响,所以在文档管理中的过程中应建立一套文档的模板。
在建立文档模板时,需要对一些格式进行要求,需要将一些基本的要素固化到文档模板中,确保文档需要的内容能够在文档中体现,例如文档的页眉页脚、文档变更历史、文档的目录方式、文档的字体等。
在建立文档时,要注意做好文档的分类,各种分类有一个清晰的定义,使用者可以清楚地知道实际使用时要采用哪种模板。如果是使用共享目录方式管理文档,需要在一个相对容易找到的文件夹目录中存放模板,如果是使用信息系统方式进行模板管理,最好能够在首页进行一个链接,让使用者可以快速的搜索到。在建立分类时,需要含有一个共同类,或者叫做公用类,因为在实际的使用过程中总是会有一些新的类别出现,也会有一些无法进行分类的文档,这个时候就可以通过共同类进行管理。