Documentation 该公司坚持在我们的所有文档中使用二进制格式

Documentation 该公司坚持在我们的所有文档中使用二进制格式,documentation,Documentation,我在一家公司工作,出于某种原因,该公司坚持我们的所有开发文档都应采用MS Word格式。这是一种二进制格式,意味着我们不能: 文档的不同版本相互冲突(因此同行评审是一件痛苦的事情——因为我们所处的领域,所有更改的同行评审都是必不可少的) Grep一个包含关键字文档的文件夹 您使用什么编写文档?为什么 另外,请给我弹药来改变这种情况……我们使用维基(特别是Trac提供的维基)的原因有两个。另外,如果我们真的需要,我们也可以获取标记的文本版本,并在纯文本环境中对其进行操作(例如,在提交期间作为s

我在一家公司工作,出于某种原因,该公司坚持我们的所有开发文档都应采用MS Word格式。这是一种二进制格式,意味着我们不能:

  • 文档的不同版本相互冲突(因此同行评审是一件痛苦的事情——因为我们所处的领域,所有更改的同行评审都是必不可少的)
  • Grep一个包含关键字文档的文件夹
您使用什么编写文档?为什么

另外,请给我弹药来改变这种情况……

我们使用维基(特别是Trac提供的维基)的原因有两个。另外,如果我们真的需要,我们也可以获取标记的文本版本,并在纯文本环境中对其进行操作(例如,在提交期间作为svn注释的一部分)


可以轻松简化为纯文本(非二进制)的格式绝对是必须的。对于我们来说,能够将其上转换为类似PDF的漂亮格式并不十分重要。

您可以要求文档采用OOXML(
.docx
,对于Word)格式。然而,在我看来,使用ODT并不像使用ODT那样理想,它仍然只是一个包含大量XML文件的zip文件。:-)

是整个开发团队都反对这个要求,还是一个小组?如果是整个团队,只需忽略授权,使用基于文本的格式——这不是员工第一次忽略愚蠢的规则。如果你过去没有对此大惊小怪的话,效果会特别好。如果您有,管理层可能会特别关注您的文档。

Word具有文档更改跟踪功能(尽管它只在您接受更改之前有效),您还可以对文档进行grep(文本未加密)。所以我不确定你的任何一个论点都能经受住审查。我很想给你弹药来改变这一切,但随着年龄的增长,我变得厌倦和愤世嫉俗


我们在文档中使用MS Word(这比早期的选择(Lotus WordPro-ugh!)有了巨大的改进。

这里不是为MS产品辩护,但MS Word可以区分文档。

MS Word支持文档更改跟踪和同行审查

新的MS Office格式完全基于XML(要查看这一点,请将MS Word.docx文件重命名为.zip,然后将其解压缩以查看)


也许Office 2007可以同时满足您的公司要求和您的顾虑?

您至少可以比较Word文档,请参阅“额外”中的“跟踪更改”命令菜单,或使用类似于。通过google search first link找到的软件。在word文档中搜索应该可以使用或其他类似的程序来索引他们能够读取的所有文件。

他们坚持你用word编写文档还是只使用word格式?你可以用文本格式编写文档并将其转换为word自动调用y、

如果您将其用作源代码管理系统的diff工具(正如我们使用Perforce所做的那样),它将显示Word文档版本之间的差异。诚然,它只显示文本差异-格式更改不显示-但这通常足以让您看到更改的内容


这只是投资超越的另一个原因,因为它是我使用过的最精巧的软件之一,而且它是最好的30美元(如果你买了几款就少了)我花了很多时间在软件上

有很多用于word文档比较的工具。我目前使用一个python脚本,在word的内置比较和合并功能上添加一个命令行


我们使用维基——特别是

这是一个商业产品,它很棒。我们选择它而不是免费/开放的wiki引擎的原因之一是它有一个全面的WYSIWYG编辑器和各种其他功能,使熟悉Word的用户更容易访问它


我们还想出了一个巧妙的方法,在Subversion中存储图像、设计、线框等,然后通过Apache/SVN web界面模块在wiki文档中嵌入指向这些资源URL的链接;如果您感兴趣,请注意我们是如何做到这一点的。

对于ammo,有一个可靠的实用程序员,第14章:编程的力量纯文本

作为务实的程序员,我们的基础 材料不是木头或铁,而是金属 知识。我们收集需求作为 知识,然后表达出来 我们的设计知识, 实现、测试和文档。 我们相信最好的格式 持久地存储知识是非常重要的 纯文本。通过纯文本,我们给出 我们自己有操纵的能力 知识,包括手动和手动 以编程方式,虚拟地使用 我们可以使用的所有工具


文本格式有助于将您的文档与生成的项目(如JavaDoc、API引用或数据字典)合并。它的可扩展性也比word好得多,因为word很难用于大型文档。最后,允许Include的格式允许多个作者同时处理文档

而且(我在这方面使用的两个系统)都具有非常优越的索引和交叉引用功能,并且都具有本机文本格式或可以包含的本机格式的文本版本(Framemaker中的MIF)。它们也都比word稳定得多


我已经构建了一些工具,可以读取数据字典并生成文档,这些文档可以包含在一个更大的文档中,具有稳定的索引和双向交叉引用。的功能规范就是这样用LaTeX完成的,并为我在公司获得了另一份工作。我还与FrameMaker开发了一个类似的过程。

我开始使用DocBookXML编写文档

另一方面,它是纯文本格式。您可以将一个大型文档拆分为多个文件,并使用节点将它们合并到一本书中。目录和索引自动生成。文档内链接(在任意文本内,指向章节或