我在一家公司工作,由于某种原因,我们坚持认为我们所有的开发文档都应该是MS Word格式.作为二进制格式,这意味着我们不能:
文档的差异版本相互对立(所以同行评审它们很痛苦 - 因为我们所处的领域,所有变更的同行评审都是必不可少的)
Grep文件夹 - 包含关键字的文档
您使用什么来编写文档？为什么？
还请给我弹药改变这种情况......
我最近开始使用DocBook XML来编写我的文档.
从好的方面来说,它是一种纯文本格式.您可以将大型文档分成多个文件,并使用节点将它们整合到一本书中.自动生成目录和索引.文档内链接(在任意文本中,指向章节或章节)非常容易.只需按一下按钮,我就可以创建一个单html文件版本,一个chunked-html版本(每章一个文件)和一个PDF版本.
经过一些调整和定制后,我对输出非常满意.文件看起来很棒 !!
DocBook是由真正的出版商(最值得注意的是,O'Reilly)的广泛使用,它的存在了十五年以上,所以它的成熟度达到了一定程度.
另一方面,所有处理都是使用XSLT完成的,使用临时工具集.(我自己的DocBook管道包括Python和Java中的Xerces,Xalan,它的Apache FOP和PDF-SAM.加上官方XSLT样式表的分布,以及我自己的XSLT自定义.)
DocBook不是一个交钥匙解决方案.如果不阅读手册,您将无法快速前进.如果您对XSLT一无所知,那么您将不得不学习.
另一方面,编写文档时,您只需要知道十二个或两个XML标记.(真正的专业文档生成过程中发挥作用从XML源).如果一个人在你的团队愿意负责编写文档生成脚本,然后其他人对球队可能只是学习DTD,做一个体面的工作贡献.
无论如何...... DocBook肯定有一些缺点.它不是最简单的科技作者系统.但它是我所知道的最好的开源工具.
"Subversion Book"是用DocBook编写的.这是一个包含不同书籍版本(单一html,chunked-html和PDF)链接的页面:
http://svnbook.red-bean.com/
这里是第一章DocBook XML源代码的链接,以便您可以了解它的工作原理:
http://sourceforge.net/p/svnbook/source/HEAD/tree/branches/1.7/en/book/ch01-fundamental-concepts.xml
对于弹药,有可靠的老实用程序员,第14章:纯文本的力量.
作为务实的程序员,我们的基础材料不是木材或铁,而是知识.我们将需求作为知识收集,然后在我们的设计,实现,测试和文档中表达这些知识.我们认为,持久存储知识的最佳格式是 纯文本.使用纯文本,我们可以使用几乎所有可供使用的工具,以手动和编程方式操作知识.
我们使用维基(特别是Trac提供的维基)是出于你提到的两个原因.另外,如果我们真的需要,我们可以获得标记的文本版本并在纯文本环境中操作它(例如,在提交期间作为svn注释的一部分).
一种可以轻松简化为纯文本(非二进制)的格式绝对是必须的.对我们来说,将它上转换为像PDF这样的漂亮格式的能力并不是非常重要.
Word对文档进行了更改跟踪(尽管它只能在您接受更改之前一直运行)并且您也可以对它们进行grep(文本未加密).因此,我不确定你的论点是否会受到严格审查.我很乐意给你弹药来改变这个但是随着年龄的增长,我变得厌倦和愤世嫉俗.
我们使用MS Word作为我们的文档(这是对早期选择的巨大改进(Lotus WordPro - 呃!).
京公网安备 11010802040832号 | 京ICP备19059560号-6 