domino相关文档就写在domino里

来源:互联网 发布:linux sftp命令下载 编辑:程序博客网 时间:2024/06/04 18:42

今天同事在整理一份domino的相关实施手册,很痛苦。不光是工作量大的问题,而是要描述的元素实在是太琐碎了。例如形形色色的domino中的各种视图、代理甚至是某个域,在word中要描述起来实在是麻烦。这样的方式有以下几个弊端:

 

1、目前的状况是写一份word文档,附加几个相关的domino模板,把涉及到的元素点清楚在哪里,要怎么操作等等。这样一份实施文档就是一个包,包括了domino数据库和word文档等组成部分,各个部分相互关联和依赖。这样的实施方案要给出来,必然要花费大量的心血。

 

2、并且弊端不仅是成稿的时候,还有以后对其中部分文档的升级、更新等整理操作,都要更新到每个关联部分,更是头痛的要命,稍有不慎就会造成难以查找的错误,徒增烦恼。

 

3、而且这样一份文档,在实施人员那里也得不到好评,实施人员会因为要打开各种数据库再参照文档操作而头大如斗,而且打开那么多进程,就连系统也气喘如牛。有时候两个同名的新旧数据库要同时打开在一个designer中来操作(本地的模板和服务器上的数据库),很容易造成错误。这样就要求实施人员在实施中要时刻保持高度的精神集中,才能重现这份文档测试时候的样子。

 

4、如果在实施中发现错误,又要在各个关联部分来查找问题,进行更新后又要在本地硬盘的工作目录中形成一个新的“实施包”。最终的结果是本应很单纯的一份实施文档,搞成了各种版本的一个乱麻麻的东西。

 

针对这样一个情况,我突然想到为什么不把实施文档直接写在domino中呢?

分析:

1、word的功能强项是在文档编辑上,例如嵌入各种图片、排版等方面。而工程文档,尤其类似实施手册这种针对内部技术人员的手册,并不需要花哨的格式,重点是要实用。这样需要的功能在domino中完全可以满足。

2、domino的元素在domino中来写,绝对的易于表达和描述。例如一个域,写到这个域的时候,直接就可以把模板中的域嵌入到文档中,这是word所不能具备的。

3、各个实施用到的部分易于整合,便于维护和备份。可以把代理、视图等,都放到一个“实施库”中,并用相关的domino文档进行描述,如需修改,则可以简单的把相关更新的元素“复制”并且“粘贴”,再在原来的元素上直接进行修改。

4、扩展一点,由于文档本身是写在domino中的,可以和编码挂钩。部分内容也许可以生成(不成熟的想法),对于维护和更新甚至可以“程序化”。并且在写文档的时候,涉及到某些简单的测试,也不必去另外打开数据库来进行,可以把所有相关元素集中在实施库中后,用到的部分直接就进行测试。

 

可行性:

目前尚未进行任何测试,但是根据分析认为值得一试。仅在此记录此想法,以便以后操作时有据可依。

 

虽然是个很小的想法,但是也还是欢迎大家提出宝贵意见,对不切实际的地方进行指正和批评。