0

私が働いている会社は、ソフトウェア開発と関連するプロセスを文書化するためにConfluenceを使い始めました。ハードコピー用のPDFとWebベースのマニュアル用のHTMLの両方として、wikiで作成されたコンテンツを使用してユーザーマニュアルを作成することを検討しています。この特定のワークフローについて誰か提案があったかどうか疑問に思いましたか?

乾杯。

4

2 に答える 2

0

まず、Confluenceを使用することの長所は、オンラインであり、多くの人が同時に変更できることだと思います。それを印刷することで、ここでの長所のいくつかを失うことになります。

Confluenceは、すぐに使用できるメカニズムを提供します。それらが十分かどうかを確認する必要があります。

したがって、次のようにします。

  1. 既存の(小さな)Wikiスペースを取得し、そのWikiスペースをHTMLとPDFにエクスポートします。のメニューエントリを参照してくださいBrowse > Advanced > HTML Export and PDF Export
  2. どのページを(階層的に)含めるかどうかを選択できます。
  3. あなたがそれを調整したいのであれば、いくつかのオプションがありますBrowse > Space Admin > PDF Layout and PDF Stylesheet(それを試したことはありません)。
  4. HTMLの場合、もちろん最初にConfluenceによってエクスポートされたスタイルシートを調整できます。
  5. それだけでは不十分な場合は、Browse > Advanced > XML Export他のテクノロジーを使用して自分でエクスポートを作成し、必要な形式でエクスポートする方法があるかもしれません。

この最初の実験で十分な場合、ワークフローは単純で、上記の4つのポイントと同様です。そうでない場合は、XML形式を使用して独自のエクスポーターを構築するのは大変な作業になる可能性があります。

もう1つのポイント:公開したいコンテンツが正確に1つのスペースに存在するというすべての要件があります。したがって、ページを含めるか除外することによってスペースを調整する必要がある場合があります

私は過去に次のような経験をしました...

  • エクスポート(PDF)のページの順序を調整する方法が見つかりませんでした。
  • PDFのレイアウトは(1つのwikiページでも)奇妙でしたが、その間に変更された可能性があります。私が行う講義(Confluenceでコンテンツを作成する)では、CSS、Operaでの印刷プレビュー、および正しい順序でのPDFの収集を組み合わせて印刷します。
  • HTML形式は問題ありませんでしたが、HTMLバージョンで表示したくないものを隠すのが非常に簡単だった場合(eg. .hide { display: none; }
于 2011-02-26T10:54:22.320 に答える
0

Confluenceユーザーガイドは、技術文書の作成方法に関して私が見つけた最高のリソースです。

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

基本的に、アトラシアンのドッグフードが自社製品を作成してドキュメントを作成する方法の概要(非常に自己参照的なサークル)。

于 2011-04-19T15:20:01.150 に答える