documentation - 将 Confluence wiki 内容转换为硬拷贝/网络用户手册的工作流程？

Question

我工作的公司已经开始使用Confluence来记录软件开发和相关流程。我们正在研究使用在 wiki 上创建的内容来创建用户手册，作为用于硬拷贝的 PDF 和用于基于 Web 的手册的 HTML。我想知道是否有人对这个特定的工作流程有任何建议？

干杯。

score 0 · Accepted Answer

Confluence 用户指南是我找到的关于如何创建技术文档的最佳资源：

基本上概述了 Atlassian 如何使用他们自己的产品来创建其文档（非常自我参考的圈子）。

score 0 · Accepted Answer

首先，我认为使用 Confluence 的优势在于它是在线的，并且可以同时被很多人更改。所以通过打印出来，你失去了这里的一些优势。

Confluence 提供了一些开箱即用的机制，您应该检查它们是否足以满足您的需求。

因此，请执行以下操作：

使用现有的（小型）wiki 空间并将该 wiki 空间导出为 HTML 和 PDF。请参阅中的菜单条目Browse > Advanced > HTML Export and PDF Export
有哪些页面要包含（分层）或不包含的选项。
如果你想调整它，有一些选项Browse > Space Admin > PDF Layout and PDF Stylesheet（从未尝试过）。
对于 HTML，您当然可以首先调整 Confluence 导出的样式表。
如果这还不够，可能有一种方法可以为自己构建导出，方法是使用Browse > Advanced > XML Export和使用其他一些技术以您想要的形式导出。

如果第一个实验足够，则工作流程很简单，类似于上面的四点。如果没有，使用 XML 格式构建自己的导出器可能需要做很多工作。

还有一点：所有这一切的前提条件是您要发布的内容恰好存在于一个空间中。因此，您可能需要通过包含或排除页面来调整您的空间

我过去有过以下经历...

我发现无法调整导出 (PDF) 中页面的顺序。
PDF 的布局很奇怪（即使是一个 wiki 页面），但与此同时可能已经发生了变化。对于我的演讲（在 Confluence 中创建内容），我通过结合 CSS 打印出来，在 Opera 中打印预览并以正确的顺序收集 PDF。
HTML 格式没问题，如果隐藏我不想在 HTML 版本中显示的内容（eg. .hide { display: none; }.

2 回答 2