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

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(使用前将#替换为@)

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

  • reST:具有任意标题的内联链接?

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

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在使用 Java 阅读 javadocs 我的java对象有属性 描述 包裹名字 方法名称 方法描
  • Link rel="canonical":不同的用户指南版本是否应该使用相同的规范 URL? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 是否应该使用 2 个不同版本的用户指南不同的规范 URL 文档版本1 1 0 Final 文档版本1 2 0 Final 或者应该使用 2 个不
  • 如何在 Xcode (Swift) 中添加自动完成注释?

    如何将文本添加到自动完成功能 如下所示 告诉元素激活自身 部分 这就是我所拥有的 但是 这是一个测试 部分不会出现在自动完成中 请不要链接到其他介绍如何编写评论的帖子 以便它们会显示在通过 Option Click 弹出的窗口中 我很清楚如
  • C#/.NET 中方法的自动记录异常 [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我想要一些工具 最好是能够插入 VS 2008 2010 的工具 它将遍历我的方法并添加有关它们可能抛
  • 将库的文档添加到手册页

    我正在使用 Ubuntu 12 04 1 我正在学习使用 C 中的 FFmpeg 库制作一个基本的视频播放器 我的手册页没有显示库的标题 函数的任何条目 有人可以告诉我一种将文档添加到我的手册页的方法吗 这样搜索比每次都在网页上搜索要容易得
  • 如何引用类中最终静态字段的值?

    使用 JavaDoc 如何引用类中最终静态字段的值 我想要 在此示例中替换为字段的值STATIC FIELD This is a simple class with only one static field with the value
  • Node.js 开发人员的高级文档 [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 最近我们的团队正在使用 Node js 开发一个新项目 开始使用 Node js 并不难 但现在我们才
  • Django Sphinx 自动模块——基础知识 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我有一个包含多个大型应用程序的项目 其中设置和应用程序文件是分开的 目录结构是这样的 项目名 init py apps init py
  • 如何在 YARD 中记录具有可变数量参数的函数?

    我有一个接受可变数量参数的函数 如下所示 def myfun args end 所有参数都具有相同类型 Symbol 所以现在我记录该函数 就像只有一个参数一样 说它可以接受多个参数 例如 this function doesn t do
  • 记录 ServiceStack Web 服务 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 用于记录基于 ServiceStack 的 Web 服务的选项有哪些 我不是在谈论单行字符串 我希望能够详细记录 可能很长 返回类型
  • HTML 元素的“默认操作”是否有标准资源? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我想知道是否有一个定义的标准来定义各种 HTML 元素的默认操作 我看过W3C 的 HTML 规范 h
  • 有已知网络爬虫的列表吗? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在尝试获取网络服务器上某些文件的准确下载数量 我查看了用户代理 其中一些显然是机器人或网络爬虫 但
  • 如何记录 IDE 的魔术(_call 和 _callStatic)方法

    在使用 notepad 和 sublime 编码多年之后 有人建议我尝试一下 PHP IDE 我正在尝试 phpStorm 它看起来不错 代码完成和文档是一个很棒的功能 但在使用魔术方法时对我来说不起作用 有没有办法让 phpStorm 了
  • python 文档字符串中的这些标签 @ivar @param 和 @type 是什么?

    ampoule 项目在文档字符串中使用一些标签 例如 javadoc 标签 例如来自pool py http bazaar launchpad net dialtone ampoule main annotate 26 file id po
  • 如何实现 JsDoc 多重继承或 mixins?

    如何记录 mixin 或多重继承 class Parent function Parent Parent prototype parentTest 5 class Mixin function Mixin Mixin prototype m
  • 如何记录数据库代码以查看数据库对象之间的依赖关系? [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我想为我的宠物项目编写文档 我的 PostgreSQL 数据库中有 30 个表 近 50 个视图和大约 30 个函数 存储过程 我想看
  • 如何共享 Swagger 文档

    我最近开始使用 Swagger 来编写文档 但有一些事情我仍然不清楚 我创建了 YAML 文档 现在我希望能够与团队的其他成员共享 pdf 或 HTML Javascript 页面中的文档 我无法使用 SwaggerHub 因为它们没有私有
  • 我如何访问 Common lisp 中 Defclass 插槽的 :Documentation 字符串

    好的 这是我如何实例化 Defclass 以及相关的 Defmethod 和 Defparameter defvar account numbers 0 defclass bank account customer name initarg
  • C++11 容器/适配器属性的实用总结/参考? [关闭]

    Closed 这个问题是无关 help closed questions 目前不接受答案 我正在寻找各种 C 11 标准容器和容器适配器的重要属性的全面总结 参考 也可以选择包括 boost Qt 但是按这些属性索引而不是通常的每个容器文档

随机推荐