软题库 培训课程
当前位置:信管网 >> 其它资料 >> 文章内容
软件开发中的文档管理
来源:信管网 2012年08月17日 【所有评论 分享到微信

文档管理,有些公司也称为知识库管理,本文还是以文档作为称呼吧。

1.先说说文档管理的历史背景和演化史吧:

一般情况下,文档可以包含很多方面的内容,一个Excel表格,一个需求设计文件,一个Bug的解决方案,一个功能的描述甚至是一个有用的图片都可以成为一个文档。所以对文档的标准解释就是文档是软件开发,使用和维护中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

当然文档不仅仅是在软件开发中需要使用,其实是在任何公司中需要用到的,甚至比如在政府单位中也都是用到的,那些法律文件,行政命令,规范纲要都是文档,前段时间经常在说无纸化办公,但是文档其实还是以电子版的形式继续存在着,所以说,文档现在是无处不在,就当前社会在说,文档是绝对不可或缺的。

既然文档是不可或缺的,必然就会涉及到一个问题,那就是文档的管理,对于文档管理的作用,简单来说就是保存,分类和检索文档。从人类发明文字以后,其实文档的管理就已经开始,从一开始的甲骨文时代到现在的电子时代,文档的管理一直在不断进行中,只是形式随着时代的变化有所变化而已。

一开始人类社会可以能是用甲骨文的形式来保存文字,一些有意义的甲骨文就成为文档,然后需要保存起来让人需要的时候再去看,但是由于甲骨文是以龟壳的形式保存,你要真的去翻看,我想还是很有难度的,所以那个时候的文档管理,纯粹是实物堆放管理,挺多知道那个相关的文档放在那个位置,要具体去找一个内容是很麻烦的。

后来的呢,人类发明用竹简开始作为文档的记录载体,但是竹简其实还是一样很笨重的,虽然比起甲骨文而言,竹简记得内容可以更多很规范点,但是要去查找内容的时候还是很麻烦。

汉朝时,终于纸横空出世了,世界上最伟大的发明之一在中国诞生了,大家记录起知识开始变得很方便,而且很便宜(之前用丝绸记录虽然也轻巧但是贵),所以文字记录自此开始几何级的增长了。很多纸叠在一起变成了书,人类为了方便查找内容,还给书做了目录,真正意义上的文档管理就开始了。

但是虽然对于主要的内容可以通过目录查找到,不过你如果想去用通过查找几个关键字的方式来查找一段具体的内容的话,电子时代到来之前,还是没法做的很好,所以当然我也很难在查查这个书库里(类似少林寺藏经楼)是否有我需要的书了,即使找也只能找到一个书名,没法通过具体一个关键字来查找书了。

到了电子时代以后,文档可以通过以0和1的方式保存在电脑中了,文档管理有了翻天覆地的变化,人类可以非常便捷地把自己想要的知识找到,而且不仅仅在一本书中,可能是在一个图书馆中的所有书中,甚至是整个世界上的大部分书中,这种阶段,已是咱们的先人根本无法想象到的。

文档管理当然也是与时俱进的,有什么样的条件就能创造什么样的文档管理,进入现代文档管理已经变得极其强大,除了最简单的保存、分类和检索以外,文档管理还是加入的安全管理,版本控制,发布控制以及在线查看,协作编写等新的功能。在进入21世纪以后,随着云计算的出现,文档管理甚至还加入了云元素。

2.DevSuite中的文档管理

文档管理在任何公司和单位中都需要,但是我想大家也清楚,文档有些公司做的好,有些公司做的不好,当然有些公司的确不需要很好的文档管理,比如一个小的施工队,只要建筑图纸保存好了就行了。但是大多数公司我觉得还是需要一个很好的文档管理的,有些做的不好的原因,我觉得有两方面原因,一方面原因当然是主观重视不够,都认为不需要怎么整理,但是一到需要的时候就急得乱找,最后可能需要重做,影响人力物力和时间;另一方面原因就是缺少一个好的文档管理系统,文档如果只在电脑上保存的话,虽然说可以查询到,但是一旦文档越来越多的话,文档管理很有可能越来越混乱,文件乱放文件夹,版本没法控制,安全性没法保证,多人同时想来看和修改的话,很难管理,类似添加评论之类的功能就更加没法实现了。

对于一个软件公司而言,可能文档管理需求可能来的更加迫切,因为软件公司有大量的需求文档,设计文档,客户文档,技术支持文档,还有一些公司内部培训,合同,制度等文档,这些文档首先需要分类,然后可以搜索,更重要是需要:

1.权限管理(有些文档不是所有人都能看到)

2.流程管理(文档需要从草稿到最终成稿需要流程控制)

3.变更管理(类似设计文档可能需要经常更改,确保每个更改能够被记录,并且应该让看过之前版本的人知道有新版本了)

4.版本管理(一个文档在不同人修改后或者不同时间修改后,需要保存不同版本,并且各个版本之间能比较差别)

主观重视还是靠公司自己来努力了,你实在不重视即使有文档管理系统也没用。对于好的文档管理系统来说,我们还是可以有选择的,市场上的工具应该挺多的,今天我只介绍一下TechExcel的DevSuite系统怎么管理文档的,因为我们公司是买了这个产品的,下面是截图。

DevSuite系统中的文档管理工具叫做KnowledgeWise,在以“知识为核心” 的理念中属于核心地位,因为软件开发过程中其实每个阶段都需要接触文档的,从需求文档到设计文档到开发文档到测试文档再到发布文档维护文档,文档自始至终一直是需要的,而且同一个文档在整个过程可能是不断发生更改的,所以通过KnowledgeWise跟踪到每个更改对于开发过程来说或是及其重要的。

在KnowledgeWise中,文档通过条目(Item)的方式来记录的,也就是一个文档对应一个条目,每个条目首先会有标题,描述,负责人,附件等字段组成,这些字段是自定义,可以根据你的需要而添加,这是所谓的基本属性。然后条目还有一些高级属性,比如权限控制,流程控制,版本控制,历史跟踪记录等等,下面我就结合我们公司的实际流程来介绍一下这个系统。

1.首先对于那些制度类的,合同类的文档,还有培训类的文档,我就不详细介绍了,因为这些文档不需要所有人都需要看到的,甚至有些需要保密的,更加不能让很多人看到了。通过KnowledgeWise可以保存到只有相关人员才能看到的地方。KnowledgeWise可以为每个人针对每个文件,每个文件夹设置不同的权限,比如只读,可以编辑,可删除,可创建当然还有不可见。所以你想设置如何复杂的权限组合都是没问题的。(权限管理)

下面的两个图中,可以看到,我们可以为文件夹与文件设置不同的权限,而且是可以为不同的人设置不同的权限的,也就意味着,就是两个人都是经理,我也可以让一个文件只让其中一个人看到。

2.然后就是一些设计文档、开发文档或者是FAQ之类的,这些文档在实际过程中总是会经过很多流程最终产生一个成品,拿设计文档来说吧,一个设计文档从最初有意向,到最后成型,可能分为以下几个部分:草稿—>初级审核—>继续修改—>再次审核—>最后修改—>最后审核—>同意,这么几个过程,而且每个过程中,负责处理的人也不一定是一样的,草稿可能是有普通设计人员处理的,初级审核应该是设计组长处理,最后审核可能是设计主管处理,所以我们就需要设置严格的工作流程和相应的权限,流程刚才已经说过了,权限的话,意思是说,比如这个文档在“初级审核”阶段,必须设计组长才有权限去把这个文档改变到继续修改状态,其他人没有这个权限,甚至其他根本就没法看到这个状态下的那个文档,这样就确保是设计组长审核过才去继续修改的,杜绝了有些人想尽快通过这个文档而直接跳过流程改状态了(当然,在KnowledgeWise中经过自定义设置是可以跳过流程改状态的,当然正常情况下,这个必须是有一定权限的人才能做的,比如主管,经理等)(流程管理)

下面两个图是一个典型的文档的流程的,第一个图是在系统中自定义设置一个流程,第二个图是系统客户端的实际使用情况,可以看到,一个文档从新建到最终成型在正常情况必须通过每个状态的负责人的处理后,走完这个流程,这样子基本上能够保证一个文档的质量。在系统中,每个能进入的系统的人,只要一进系统就可以看到自己需要处理的不同状态的文档任务,包括写文档、修改文档和审核文档。

3.软件公司的做设计的人应该知道,对于一个设计文档而言,会不断地经过修改,即使是最后定稿了以后,可能一个新的改动过来,又得改,但是经常地我们也碰到了一种问题,就是我改完了,但是发现改错了,想看看原来是怎么样了,或者客户不满意想改回一个礼拜之前那个设计,总之就是我想还能看到这个文档每次改动时内容,然后进行一些回滚操作,或者有时候需要对两个不同版本的内容进行比较,看看到底做了哪些改动,改动前是什么,改动后是什么。(变更管理,版本管理)

在KnowledgeWise中,对一个文档条目,每一次操作都能用快照方式记录一个版本,所谓快照方式,就是类似一个拍照功能,把该版本文档的相关内容拍下来,以后只能看,不能改。当然,你可以设置不让每次修改都保存版本,只修改一些关键地方的地方才去保存一个版本,不然版本太多,以后比照起来也挺累人的。

对于保存下来的版本,主要有三个用处,

第一个当然是去看唠,可以看看在过去某个时段,这个文档是啥内容;

第二个内容就是回滚作用,就是说如果一旦我这个文档修改了一下,觉得不对,想恢复到修改前的样子,就可以回滚一下,当然你是可以回滚到任何已经保存下来的版本里的,那么那个版本里的内容将会覆盖当前内容,所以一般情况下如果想回滚的话,你可以先手动做个版本保存,这个在KnowledgeWise中是允许的,而且即使做了回滚,所有的已经保存的版本还是不会受影响的。

第三个作用就是两个版本间的相互对比,有时候我们作了修改后,想对比一下两个版本之间到底有什么不一致,究竟改了多少地方,一旦我们用了对比功能以后,就可以把这个文档的所有字段在不同版本间进行一一对比,有修改的地方会被自动标记,例如这个版本比那个版本就是删除了一段话,这样子的话,对比的时候,被删除的这段话就会自动加上颜色,并且会加上一个删除的线,一目了然。(关于对比这个功能,有些版本控制管理软件其实做得更好,类似Subversion,所以KnowledgeWise也提供了跟Subversion集成的效果,有任何文件作为附件放到一个文档里去的时候,可以同时被自动提交到Subversion中,这样子,就可以对附件也进行对比了)

下面的图就是版本保存的地方。

4.类似FAQ这些文档,其实最终我们做完后是给我们的客户用的,也就是给他们看的,作为帮助文档的方式,所以放在系统中的话,就不太适合他们去看,可看性不好,所以KnowledgeWise提供了一种Wiki功能,可以将指定的文档用Wiki方式给用户看,下面就是一个典型的FAQ在线帮助的截图。

5.另外的话,KnowledgeWise还支持直接由Word或者PDF文档中直接把内容导入到系统中作为一个条目,甚至可以把Word/PDF中分段的内容导成几个相关联的条目,当然也支持导出功能和报表功能了。

6.KnowledgeWise的文档管理支持服务器-浏览器形式的访问,所以只要你能访问你们公司的网页,你就能访问到你想要的文档,局域网与广域网访问起来没有任何区别。

总的来说,KnowledgeWise是一个非常棒的文档管理系统,完全满足了我们公司的要求,甚至超出了不少期待,因为它能跟我们买的其他TechExcel产品做无缝的集成,也就是说一个文档我可以在不同产品中都能看到,如果有更新我也能一下子看到,对于我们公司的软件开发过程是相当有帮助的。

扫码关注公众号

温馨提示:因考试政策、内容不断变化与调整,信管网网站提供的以上信息仅供参考,如有异议,请以权威部门公布的内容为准!

信管网致力于为广大信管从业人员、爱好者、大学生提供专业、高质量的课程和服务,解决其考试证书、技能提升和就业的需求。

信管网软考课程由信管网依托10年专业软考教研倾力打造,官方教材参编作者和资深讲师坐镇,通过深研历年考试出题规律与考试大纲,深挖核心知识与高频考点,为学员考试保驾护航。面授、直播&录播,多种班型灵活学习,满足不同学员考证需求,降低课程学习难度,使学习效果事半功倍。

相关内容

发表评论  查看完整评论  

推荐文章