为什么要使用DocBook呢?
实现单一源文件维护
一个文档需要不同的格式输出,并不算罕见。因为今天用户的环境千差万别,用户习惯的文档格式也是五花八门,要想使得更广大的用户群能够阅读到您所提供的电子文档,同一内容的不同输出就变得非常重要。但这样就大大增加了文档维护的困难,为文档工程师带来沉重的负担,单一源文件维护(single-sourcing)就成了迫切的需要。
DocBook文档采用 SGML/XML 格式。开放的数据格式配合丰富的工具软件,让单一源文件维护成为了可能。
实现文档的版本控制
没有版本控制,软件研发的管理将处于一种作坊式的无序状态。而文档又何尝不是如此呢?
如果你问一个采用了版本控制系统的团队的开发人员,今天的代码和昨天的代码有什么不同,相信他会连一个增加的标点都会告诉你。而你要去问他,你的第二版的概要设计比第一版多了哪些东西,他可能就要支支吾吾了。这是什么原因造成的呢?
目前几乎所有的版本控制系统、代码比较程序,只能对纯文本进行完美的、增量的版本控制。而像WORD、PDF等格式的文档,是以二进制的形式存在的,难以实现各个副本之间的比较。而DocBook文档是存文本格式的文档,可以类似代码管理一样进行文档的版本控制。
IT企业的知识管理和文档管理
IT企业中的知识管理、文档管理关乎企业的发展和生存。试想处于知识经济前沿的IT企业如果没有了知识管理,必然造成知识老化,被新兴的企业淘汰;试想人员变动频繁的IT企业没有了文档管理,业务的连续性就会随着核心人员的离去而受到致命一击。
虽然大多数IT企业都对员工有着撰写各种文档的要求,但是大多数文档只是为应付领导而存在,一旦完成便束之高阁,不加维护,且难以维护,成为文件服务器中的数字垃圾。
DocBook文档由于能够进行版本控制,使得多人参与撰写和维护成为了可能。积极的参与一方面提高了文档的更新频率,另一方面提高了员工的参与意识和良好的知识管理的习惯。
个人知识积累、知识共享的好帮手
在知识经济的时代,知识就是资本,但是这个资本不能从天而降,需要靠不断的积累;知识有很强的时效性,需要不断的更新。IT行业的从业人员,更无时无刻不要面对新知识,需要解决新问题。如果只是简单的求新、求变,不注重知识的积累,那么当有一天对新鲜事物丧失兴趣或者无力追捧的时候,就是需要离开这个行业的时候了。这也是这个行业的一条流行用语意义之所在——“搞IT是在吃青春饭”。
IT行业需要新鲜血液没错,但它更需要经验丰富的领军人物。怎样才能让自己的职业生涯更加持久,我的答案是知识积累。DocBook作为技术文档的撰写模式,它的持久性、可维护性、可版本控制,使得它可以作为个人知识总结、积累的得力途径。
http://www.worldhello.net 就是我用DocBook技术建立的个人知识积累之所。通过本书,介绍给大家。
采用DocBook格式写文档的风险有多大?
一方面,是学习成本的忧虑。学习DocBook,就必然要学习SGML/XML的基础知识,熟悉DocBook DTD定义的元素。SGML/XML的学习要经历一条陡峭的学习曲线,可能会遇到一定的挫折。但是以我的经验,开始使用DocBook并不需要成为SGML/XML专家,而且随着DocBook的使用,会加深对SGML/XML的理解。从实际入手学习XML这一今日之星,不能不说是意外的收获。
另一方面,是对应用软件的顾虑。诚然撰写DocBook文档,目前还没有像Word、WPS这样所见即所得的文档编辑工具,更多的是使用最简单的纯文本编辑工具,这可能吓跑好多人。撰写DocBook文档,就要改变撰写文档的方式,这是一关。DocBook文档是一种结构化的文档,表现形式并不是在文档撰写过程中需要考虑的,把文档撰写者从文档的格式化中解放出来,增加了文档格式的统一,也一定程度的减少了工作量。
采用DocBook格式的文档会不会过时
DocBook格式的文档是纯文本的、结构化的,也是自解释的。相比二进制格式的文档,更易解析。我们可能遇到这样的情况:找出十年前的一个文档,发现它是基于某一个专有的文档编辑软件编写的二进制格式的文档,如果这种编辑软件现已不流行,甚至已经功成身退,你有信心能够顺利打开它么?这个文档可能就成了天书、数字垃圾。是否想过今天我们的WORD文档,十年后是否也会象今天一样潇洒的打开?再想象一下一百年后有个历史学家想要查找一个电子文档库,如果是诸如Word的二进制文档,这些历史学家必须绞尽脑汁的去破解它们,这不会比破译口令更容易。
对于一个要长久保存的文档,一个易于理解的格式是多么的重要。大胆的使用DocBook来撰写你的文档,它能帮你写出传世之作。
Copyright © 2006 WorldHello 开放文档之源 计划 |