Confluence を技術文書の作成に使用する

Confluence は、技術文書の取り込み、配布、更新を支援する一連の機能やアドオンを備えた柔軟なプラットフォームです。以下に示すのは、技術文書サイトを始めるのに役立ち、文書のライフサイクルを管理する時間と労力を節約するヒントです。

ドキュメンテーション スペースを作成する

ドキュメントを開始するには

  1. Confluence のナビゲーションで、[スペース] > [すべてのスペースを表示] > [スペースを作成] の順に選択します。

  2. [文書のスペース] を選択して (これによって検索ボックス (livesearch マクロ) を備えたカスタム ホームページが提供されて、最近の更新マクロなどを検索できます) [次へ] をクリックします。

  3. スペースに名前を付けて、作成 をクリックします。

Confluence はスペース キーを自動的に作成してスペース概要を作成します。概要はいつでも自由にカスタマイズしてください。ホームページの外観はお客様の思いどおりです!


コンテンツの再使用による時間の節約

単語、文、段落や画像、製品のバージョン番号、その他何でも、ドキュメント スペースで何回も使用するつもりであれば、それを 1 回作成しておいて、あとで好きなだけページに含める (インクルードする)、またはヘッダーやフッターに使用できます。インクルードは、同じことを何度も入力する手間を省くだけでなく、変更がより簡単になります。47 か所で情報を更新するよりも、1 か所で更新する方がはるかに楽です。

コンテンツの再利用を可能にするマクロは 3 つあります。

  • 抜粋マクロ: ページ上で再利用可能な部分を定義または「抜粋」します。このマクロの中にコンテンツを追加すれば、好きなだけページで再利用できます。

  • 抜粋インクルード マクロ (excerpt-include): 別のページから抜粋したコンテンツを含めます。

  • インクルード ページ マクロ (インクルード): ページのコンテンツ全体を別のページに含めます。

たとえば、製品のメジャー リリースごとにリリース ノートを作成して、各リリース ノートの前書きページを「新着情報」ページに含めるとします。各リリース ノートの前書きを抜粋マクロに、次に一連のリリース ノートの抜粋インクルード マクロを新着情報ページに追加します。前書きがさっと新着情報ページに表示されて、リリース ノートを更新すると新着情報も自動で更新されます。

  1. 抜粋: これらのページへの導入は、抜粋マクロにあります。 

  2. 抜粋インクルード: 抜粋インクルード マクロです。 

インクルード ページ マクロのもう 1 つの使用例を紹介します。アトラシアンのドキュメントに省略記号が表示されている場合 ([] > [コピー] など)、この省略記号はインクルード ページ マクロによるものです。その画像しかないページがあるので、省略記号が必要になるたびにそのページを追加します。

小さな画像 1 つのためにインクルード ページ マクロを使用しているのは、UI 要素の変更に備えているためです。すべてのページに画像を添付した場合は、変更時に 50 ページの更新が必要になる可能性があります。インクルード ページ マクロを使用していれば、1 度の更新ですべての箇所を変更できます。また、この方法によってその画像を使用しているページ数を把握できます。[] > [ページ情報] の順に移動すると、このページに対するリンクの数と画像を使用しているページ数を確認できます。

インクルードライブラリーを作成する(オプション)

どの Confluence ページのコンテンツでもインクルードできますが、「インクルードライブラリー」を作成して、再利用専用にコンテンツを保存するのもよいでしょう。インクルードライブラリーは、Confluence の特殊な機能ではありません。インクルードライブラリーのページは、他の Confluence ページとまったく同じです。再利用専用にコンテンツを保存する場所が必要な場合に使える、単なるテクニックなのです。

インクルードライブラリーを作成するには:

  1. [作成] を選択して、スペースに新しいページを作成します。 

  2. 適切なタイトルを入力します。ここでは「_ConfluenceInclusions」とします (タイトルの前のアンダースコアは、このページが特別であることを知らせるのに役立ちます)。 

  3. コンテンツを入力し、ページを公開します。アトラシアンでは、インクルード ライブラリーの目的とコンテンツを再利用する方法を説明するテキストを入力しています。 

  4. サイド バーで [スペース設定] を選択します。

  5. [ページを管理] カードから [並び替え] を選択します。 

  6. 山括弧 [>] を選択して、ページ ツリーを展開します。

  7. スペース概要のに新しいページをドラッグします。 

  8. 新しいインクルード ページに移動して [作成] を選択し、再利用可能なコンテンツを含む子ページを追加します。

  9. インクルージョン ライブラリの場所: インクルージョン ライブラリを、残りのドキュメントの上にドラッグします。 

スペースの「ルート」にページを移動したため、スペース のページ セクションには表示されません。しかし、インクルードライブラリのページは普通の Confluence のページであるため、他の検索には表示されます。


ページ テンプレートを使用する

同じレイアウトで多くのページを作成している場合、1 つ以上のページテンプレートを作成しておくのは、実に時間の節約になります。あなたは常にパネルとコンテンツの表のように、同じマクロを追加する場合は、RSIから自分自身を保存し、テンプレートに入れて - あなたは1で始まり、しかし、あなたはあなたの効率を最大化するために必要な数を作ることができます。

すべてのスペースで利用可能なページ テンプレートを作成するには:

  1. Confluence ナビゲーションで [ (設定)] に移動します。

  2. 左側の一覧からグローバル テンプレートおよびブループリントを選択します

  3. 右上にあるグローバル ページ テンプレートの追加ボタンを選択します。

  4. テンプレートページを作成し、保存を選択します。

ページ テンプレートの詳細については「ブループリントとユーザーが作成したテンプレート」をご参照ください。

グローバル テンプレートとブループリント」や他の管理ページに素早く移動する場合は、/ を押して参照する管理ページの名前を入力し始めます。


下書きを作成する

ドキュメントで新しいページを作成する際、時間をかけて、保存しながら作成し、数人にレビューをしてもらい、フィードバックを受け取りたいことでしょう。つまり、このワークフローは、「ドラフト、レビュー、公開」となります。

不完全なページはユーザーに見せたくないでしょうし、多くのドキュメントは最終版とする前にレビューが必要となります。そこで、ページのドラフト作成とレビューを可能にする技術をご紹介します。

  1. ページを作成して権限を制限します。たとえば、閲覧をチームなどの一連のユーザーに制限、または特定のユーザーを指定できます。公開サイトの場合は、閲覧をスタッフ メンバーのみに制限すれば、そのページは一般ユーザーには表示されません。

  2. ページのコンテンツを記述します。 

  3. レビュアーとページを共有して、フィードバックを依頼します (レビュアーにページへの閲覧制限をかけないようにご注意ください)。レビュアーは、ページの下部にコメントを追加、テキストを選択してインラインでコメントを追加できます。また、権限を付与すれば、レビュアーはページのコンテンツを直接編集できます。

  4. 準備が整ったら、以下の手順にしたがってページを公開します。

    1. ページからコメントを削除する。 

    2. ページ制限を解除し利用者が閲覧できるようにする。 

これでページが公開されました。今度は、スペース権限とサイト権限により、ページを閲覧および/または更新できる人を決定します。


いずれのドキュメンテーション サイトにおいても、ページからページへリンクを設定できる必要があり、ページの特定セクションへのリンクも珍しくありません。Confluence ページにはどんな URL でも追加可能です。Confluence が自動的に検知し、リンクへと変換します。

Confluence サイトの他のページに URL を貼った場合、Confluence はリンクテキストをページ名として表示し、関連リンクに変換します。つまり、もし、ページ名が変更されても、Confluence がリンクを調整するためリンクが切れることはありません。

レガシー エディターでは、アンカー マクロによって任意の場所からリンクできるアンカーをドキュメントに作成できます。このページではトップにアンカーを追加してあるので、それをクリックするとページのトップに戻ります。このマクロは、新しいエディターでは利用できません。

レガシーまたは新しい各エディターでコンテンツをリンクする方法の詳細については、リンクとアンカーのドキュメントをご確認ください。


便利なマクロ

Confluence ではさまざまなマクロを用意しています。技術文書に非常に便利なマクロも数種類ありますので、いくつかご紹介します。

コンテンツ テーブル マクロ

目次マクロではコンテンツの構成を要約してページで使用されている見出しへのリンクを提供できるため、長いページのナビゲーションに役立ちます。マクロを追加するだけで使用できるのが最大の長所です。一度マクロを追加するとマクロが見出しを自動で検出して、それらを目次に追加します。

ヒント・注意・情報・警告・パネルマクロ

ドキュメントの作成時には、よく強調したい要素や読者の注意を惹き付けたい要素が出てくるものです。Confluence では、ヒント、情報、警告、注意パネルの各マクロが用意されています。これらは、コンテンツの特定の部分に読者の注意を惹き付ける際に効果抜群です。

これらのマクロはそれぞれ従来のエディタの一部ですが、新しいエディタでは 1 つの情報パネル要素にまとめられています。

 


ページ更新をトラッキングする

Confluence では、1 ページを複数の人間が更新することがよくあります。テクニカルライターは、レビュー中も公開後も、ドキュメントの状態を把握しておく必要があります。

ページやスペースをウォッチする

変更があった際にわかるように、ページやスペース全体すらもウォッチすることをお勧めします。ウォッチしているページに変更やコメントが加えられると、誰がどのような変更を行ったかについてメール通知されます。

ドキュメンテーション スペースのページを開いているときに、右上にあるウォッチボタンを選択します。そのページのみをウォッチするか、スペースの全ページをウォッチするか選択できます。

ページ履歴を見る

Confluence は、ページが編集される度に新しいバージョンを作成します。ページ履歴は、更新日、作成者、コメントとともにすべてのバージョンを表示します。

ページ履歴を確認するには、該当のページに移動して [ページ履歴] を選択します。 

ページ履歴ビューでは、以下の操作が可能です。

  • ページの特定のバージョンのコンテンツを見る。

  • 指定のバージョンに戻す (復元する)。

  • 2 バージョン選択して比較し、変更箇所を確認する。

投稿者リストを表示する

ページの更新者を知りたい場合は、投稿者マクロを追加できます。このマクロは、作成、編集を行った投稿者のリスト (カスタマイズ可能) を表示します。オプションで、コメントした投稿者も表示できます。

 


PDF エクスポートのカスタマイズ

ドキュメントを PDF で提供する予定がある場合は (メール、ダウンロード、印刷、その他の配信方法により)、タイトルページ、ヘッダー、フッターを追加することで PDF の表示をカスタマイズできます。

このプロセスは、PDF エクスポートのカスタマイズを 1 つのスペースに対して行うか、サイト全体に対して行うかによって異なります。これらの変更に興味がある場合は、詳細な方法を「PDF へのエクスポートをカスタマイズする」ページをご参照ください。


その他の便利なツールとアプリ

ドキュメントやワークフローのニーズに合わせてアプリを使用して、Confluence を拡張できます。Confluence の機能を拡張できる便利なアドオンが、Atlassian Marketplace で提供されています。これらの多くはアトラシアンでも使用しています。

Copy Space (サポート対象外)

Copy Space for Confluence アプリによって、その名のとおり、スペース管理者はスペース内のページを含むスペース全体をコピーできます。他のスペースを作成する際にコピーして使用するスペース テンプレートがある場合に、大変便利です。

このアプリは、現在のスペースを特定のタイミングでアーカイブする必要がある場合にも便利です。例えば、製品のとあるバージョンから次のバージョンへ移行する際などに、スペースをコピーし、新しい名前を付け、任意の場所に保存しておけば、既存のスペースを失うことはありません。

 Copy Space アプリでは現在、ページ履歴、ブログ投稿およびメールのコピーは行われません。

Gliffy(サポート対象)

Gliffy によって、図、ワイヤーフレーム、フローチャートなどを作成できます。Gliffy の特長は、極めて直観的なドラッグ & ドロップのインターフェイスです。また、JPEG、PNG、SVG などの様々なフォーマットに図をエクスポートできます。Gliffy のフローチャート、 UI ワイヤーフレーム、ネットワーク図を Confluence ページに直接追加して、アイデアを視覚的に伝えて理解し、チーム全体で素早く共有しましょう。

Lucidchart(サポート対象)

Lucidchart Diagrams Connector によって、Confluence Cloud サイト内で図を作成して挿入できます。フローチャート、ワイヤーフレーム、UML 図、マインド マップなどを機能豊富なエディターで簡単に作成できます。

テクニカル ドキュメントとしての Confluence をお試しください。

その他のヘルプ