将Confluence维基内容转换为硬拷贝/网络用户手册的工作流程?

时间:2010-04-23 00:54:44

标签: documentation workflow confluence

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

干杯。

2 个答案:

答案 0 :(得分:0)

首先,我认为使用Confluence的优势在于它可以在线并且可以被很多人同时更改。因此,通过打印出来,你可以放弃一些优点。

Confluence提供了一些开箱即用的机制,您应该检查它们是否足够。

请执行以下操作:

  1. 获取现有(小)维基空间并将该维基空间导出为HTML和PDF。查看Browse > Advanced > HTML Export and PDF Export
  2. 中的菜单条目
  3. 有哪些页面可以包含(分层)或不包括。
  4. 如果你想调整它,Browse > Space Admin > PDF Layout and PDF Stylesheet中有一些选项(从未尝试过)。
  5. 对于HTML,您可以先调整Confluence导出的样式表。
  6. 如果这还不够,可以使用Browse > Advanced > XML Export为自己构建导出,并使用其他技术以您希望的形式导出。
  7. 如果第一个实验已经足够,那么工作流程是直截了当的,类似于上面的四点。如果没有,那么使用XML格式构建自己的导出器可能需要做很多工作。

    还有一点:对所有内容的要求是,您要发布的内容只存在于一个空间中。因此,您可能需要通过包含或排除页面来调整空间

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

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

答案 1 :(得分:0)

Confluence用户指南是我发现的有关如何创建技术文档的最佳资源:

http://confluence.atlassian.com/display/DOC/Developing+Technical+Documentation+on+Confluence+Wiki

基本上概述了Atlassian如何通过自己的产品来创建自己的文档(非常自我引用的圈子)。