Confluence Wikiコンテンツをハードコピー/Webユーザーマニュアルに変えるためのワークフロー? [閉まっている
-
01-10-2019 - |
質問
私が働いている会社は使い始めました 合流 ソフトウェア開発と関連するプロセスを文書化するため。 Wikiで作成されたコンテンツを使用してユーザーマニュアルを作成することを検討しています。これは、Webベースのマニュアル用のハードコピー用のPDFとHTMLの両方です。誰かがこの特定のワークフローについて何か提案を持っているかどうか疑問に思っていましたか?
乾杯。
解決
まず第一に、コンフルエンスを使用する強い点は、それがオンラインであり、多くの人々が同時に変えやすいということだと思います。そのため、それを印刷することで、ここでの長所のいくつかを失います。
Confluenceは、すぐに使用できるメカニズムを提供し、それらが十分であるかどうかを確認する必要があります。
次のことを行います。
- 既存の(小さな)wikiスペースを取り、そのwikiスペースをHTMLとPDFにエクスポートします。のメニューエントリを参照してください
Browse > Advanced > HTML Export and PDF Export
- (階層的に)含めるかどうかのページがあります。
- チューニングしたい場合は、いくつかのオプションがあります
Browse > Space Admin > PDF Layout and PDF Stylesheet
(それを試したことはありません)。 - HTMLの場合、最初にConfluenceによってエクスポートされるStyleSheetsをチューニングできます。
- それで十分でない場合、使用して自分のためにエクスポートを構築する方法があるかもしれません
Browse > Advanced > XML Export
他のテクノロジーを使用して、それを持ちたい形式でエクスポートします。
この最初の実験で十分な場合、ワークフローは単純で、上記の4つのポイントに似ています。そうでない場合、XML形式を使用する際の独自の輸出業者の構築は、やるべきことがたくさんあるかもしれません。
もう1つのポイント:それがすべてのことを、あなたがまさに1つのスペースでライブを公開したいコンテンツがということです。そのため、ページを含める、または除外してスペースを調整する必要がある場合があります
私は過去に次の経験をしました...
- エクスポート(PDF)のページの順序を調整する方法は見つかりませんでした。
- PDFのレイアウトは奇妙でした(1つのWikiページでも)でしたが、その間に変更された可能性があります。私が与える講義のために(コンフルエンスでコンテンツを作成する)、CSSの組み合わせ、オペラでの印刷プレビュー、適切な順序でPDFを収集することで印刷します。
- HTML形式は問題ありませんでした、そして、私がHTMLバージョンに表示したくないものを隠すのが非常に簡単だったら(HTMLバージョン)
eg. .hide { display: none; }
.
他のヒント
Confluenceユーザーガイドは、技術文書の作成方法に関して私が見つけた最高のリソースです。
http://confluence.atlassian.com/display/doc/developing+technical+documentation +on+confluence+wiki
基本的に、Atlassian DogFoodが独自の製品をどのようにしてドキュメントを作成するかの概要(非常に自己参照サークル)。