公司坚持对我们的所有文档使用二进制格式[关闭]

2024-03-09

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

  • 文档的不同版本彼此不同(因此同行评审是一件痛苦的事情 - 由于我们工作的领域,所有更改的同行评审都是必不可少的)
  • Grep 一个充满关键字文档的文件夹

您使用什么来编写文档以及为什么?

也请给我弹药来改变这种情况......


我最近开始使用 DocBook XML 来编写我的文档。

从好的方面来说,它是纯文本格式。您可以将一个大文档分成多个文件,并使用节点将它们全部合并到一本书中。目录和索引是自动生成的。文档内链接(在任意文本内,指向章节或部分)非常容易。只需按一下按钮,我就可以创建单个 html 文件版本、分块 html 版本(每章一个文件)和 PDF 版本。

经过一些调整和定制后,我对输出非常满意。文件看起来great!!

DocBook 被真正的出版商(最著名的是 O'Reilly)广泛使用,并且它已经存在超过十五年了,所以它已经达到了一定的成熟度。

另一方面,所有处理都是通过 XSLT 使用临时工具集完成的。 (我自己的 docbook 管道包括 Python、Java、Xerces、Xalan、Apache FOP 和 PDF-SAM。加上官方 XSLT 样式表分发以及我自己的 XSLT 自定义。)

DocBook 不是交钥匙解决方案。如果不阅读手册,您将无法快速上手。如果您对 XSLT 一无所知,您就必须学习。

另一方面,您真正需要知道的只有一打或两个 XML 标记。write文件。 (真正的专业知识在从 XML 源生成文档的过程中发挥作用。)如果团队中的一个人愿意负责编写文档构建脚本,那么团队中的其他人都可以学习 DTD 并完成一份体面的工作贡献。

无论如何... DocBook 肯定有一些缺陷。对于技术作者来说,这并不是最简单的系统。但它是我所知道的最好的开源工具。

《Subversion Book》是用 DocBook 编写的。这是一个包含不同书籍版本(single-html、chunked-html 和 PDF)链接的页面:

http://svnbook.red-bean.com/ http://svnbook.red-bean.com/

这里是第一章的 DocBook XML 源代码的链接,以便您可以了解它是如何工作的:

http://sourceforge.net/p/svnbook/source/HEAD/tree/branches/1.7/en/book/ch01-fundamental-concepts.xml http://sourceforge.net/p/svnbook/source/HEAD/tree/branches/1.7/en/book/ch01-fundamental-concepts.xml

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

公司坚持对我们的所有文档使用二进制格式[关闭] 的相关文章

  • 如何将 < > 括起来的项目添加到文档注释中

    我正在尝试编写文档注释 但是我遇到了问题
  • System.Web.Razor API 文档 [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 此类型 成员支持 NET Framework 基础结构 并且不适合直接在代码中使用 谁能说出以下事实 System Web Razor http
  • NUnit.Mocks 文档在哪里? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 NUnit 的模拟库 NUnit Mocks 的文档在哪里 我在他们中找不到任何东西官方文档 http
  • 记录 WCF 接口的最佳方式? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 因此 我正在使用 WCF 并且想要记录我的接口和服务 以便提供给另一家公司的内部应用程序 记录这些接口的最佳方法是什么 我更喜欢将文档与代码内联
  • 有没有办法为嵌套函数生成 pydoc? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在寻找一种为嵌套函数生成文档 本例中为 pydoc 的方法 这可以用 pydoc 实现吗 用其他工
  • 为根包生成 scaladoc

    我很好奇如何记录root包 显示为第一页scala 文档 http docs scala lang org 汇编 可以以某种方式创建一个引用根包的包对象 或者是否有任何配置选项 对此事的描述有些模糊 scaladoc 似乎有一个名为 doc
  • reST:具有任意标题的内联链接?

    如果我定义了内部超链接目标 如何使用任意文本作为链接标题链接到它 例如 This is a very long internal link target A short reference to the very long link tar
  • 发行说明,有什么用? [关闭]

    就目前情况而言 这个问题不太适合我们的问答形式 我们希望答案得到事实 参考资料或专业知识的支持 但这个问题可能会引发辩论 争论 民意调查或扩展讨论 如果您觉得这个问题可以改进并可能重新开放 访问帮助中心 help reopen questi
  • Link rel="canonical":不同的用户指南版本是否应该使用相同的规范 URL? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 是否应该使用 2 个不同版本的用户指南不同的规范 URL 文档版本1 1 0 Final 文档版本1 2 0 Final 或者应该使用 2 个不
  • PHPDoc 文档生成器是在 Eclipse 中还是在 Eclipse 之外? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在使用 Eclipse PDT 进行开发 我一直在代码中添加 phpdoc 注释 但实际上从未在
  • LLDB GUI 的文档

    我最近一直在研究 LLDB 的 GUI 功能 有关此功能的 stackoverflow 链接有描述here https stackoverflow com questions 19820247 is there a tui mode for
  • Java 文档重写方法不具有 InheritDoc

    重写另一个方法的方法不会继承它所重写的方法的文档 有没有办法明确告诉它继承文档 inheritDoc This implementation uses a dynamic programming approach Override publ
  • 如何记录 Delphi 中引发的异常? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我经常调用一个函数Foo并想知道这个函数可能会抛出什么异常 为了找出答案 我然后研究了实施Foo 但这还不够 Foo确实可能调用一个函数Bar这
  • 将 JsDoc3 用于大型应用程序,如何将模块分组为部分/类别/子模块

    我正在开发一个应用程序 随着时间的推移 它会变得相当庞大 我决定使用JsDoc3 and DocStrap记录所有模块 模块是通过 require js 定义的 在某些地方它们的嵌套深度可达 3 或 4 层 到目前为止 我了解到 JsDoc
  • 在哪里记录 C 或 C++ 中的函数? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我有一个包含多个文件的 C 程序 所以我有 例如 stuff c它实现了一些功能 并且stuff h与函数原型 我应该如何在注释中记录功能 我应
  • GitHub 错误 Probot:未找到集成,documentation_url

    我在使用 GitHub 的 Probot 应用程序时遇到身份验证问题 当我使用 npm start 运行应用程序时 我会得到 github Github request GET app installations 404 Not Found
  • C#中同步接口和实现注释的方法

    是否有自动方法在接口及其实现之间同步注释 我目前正在记录它们 并且不想手动使它们保持同步 UPDATE 考虑这段代码 interface IFoo
  • VS2012如何通过IntelliSense显示标准C++库的文档?

    几天前 我开始使用 Visual Studio 2012 学习 C 我习惯于使用 IntelliJ IDEA 进行 Java 编程 并且在调用方法时总是会显示文档和预期参数 有没有办法在 VS2012 中为 C 执行此操作 如果我理解正确的
  • 如何在 Javadoc 中创建多级缩进?

    假设 作为记录代码 Javadoc 的一部分 您希望使用深度缩进来指示元素之间的关系 如何创建嵌套列表 some element some other element 还有一些其他元素 ul li Element li ul li Sube
  • 接手一个项目 - 我应该问以前的程序员什么? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我正在接管一个商业网站的开发 该网站是由另一位程序员花费两年多的时间开发的 这主要是一项单人工作 维护和扩展网站 我将有 2 3 天的过渡期 届

随机推荐