Seven Reasons to Use Confluence for Technical Documentation

Technical Writer がカンファレンスで会うと、最初の質問の 1 つは大抵の場合、次のようになります。 「どのヘルプ オーサリング ツールを使ってヘルプ コンテンツを作成していますか? そして、その質問の後には、「代わりにどのツールを使いたいですか」

この時点で、技術者コミュニティ内のほとんどの人は、「FrameMaker」、「Flare」、または CMS といった答えを期待しています。 しかし、K15t のテクニカルライターである Nils Bier 氏に尋ねると、彼はその答えで彼らを困惑させます。 「私たちは、エンタープライズWikiとチームワークスペースであるConfluenceと、最新のScroll Appsを組み合わせて使っています。 そして2つ目の質問ですが、Confluenceはヘルプコンテンツや製品ドキュメントを管理するためのお気に入りのツールでもあります。” その理由をご紹介します。

#1 – Confluence は全社的に使用できる

K15t では、すべての部署で Confluence を使用しています。 すべての社員が社内のConfluenceスペースで関連情報を共有しています。 開発者は仕様を整理し、設計上の決定を Confluence に記録しています。 そして、次の論理的なステップは、サポートと製品のドキュメントを管理するために Confluence を使用することです。 Confluence ベースのヘルプセンターはこちらでご覧いただけます。

Confluence ユーザーアカウントを持つことはとても重要だと考えていますので、K15t の新入社員には個人用メールアドレスが与えられると同時に、Confluence ユーザーアカウントが与えられます。 つまり、K15t の全社員は初日から Confluence のユーザーアカウントを持ち、Wiki にアクセスし、ドキュメントへの貢献、開発、改善を支援することができるのです。 そして、全員が同じツールでコラボレートしているのです。 この wiki プラットフォームにより、誰もが簡単にコンテンツを共有し、コメントし、改善することができます。 同じことが Confluence の製品ドキュメントにも当てはまります。

そして Nils は、それだけに留まらないことを知っています。 “私たちはウェブサイトやブログのコンテンツ管理にも Confluence を使用しています。” 本当です! 今読んでいるブログ記事は、Confluence から Scroll Viewport によって配信されています。

#2 – Confluence は期待通りに動く

Confluence を一度見た人は、ほとんど即座に使い方を知っています。 そして、他の Wiki エンジンとは異なり、Confluence は、ユーザーが Confluence で作業することを心から鼓舞してくれます。 Confluence はクリーンなユーザーインターフェイスと、Microsoft Word のような一般的な DTP ソフトウェアやワープロソフトと非常によく似た方法で動作するエディターを持っています。 そして、すぐに、新しい Confluence ユーザーは皆、プロのように書き込み、コメントし、共有します。

Confluence には、ユーザーがすばやく一貫したコンテンツを開発できるように、ページ テンプレート (例: 会議メモやサポート ドキュメントのカスタム ページ テンプレートなど) があります。 これは、一貫したページ構造とコンテンツを確保するための素晴らしい方法です。 しかし、作成者がテンプレートを超えることを決定した場合、それも可能です。

Nils はこれが大好きです。 「Confluence は私がコンテンツを構造化することを可能にしますが、同時に、ユーザーに創造性を発揮する自由を与えてくれます」

#3 – Confluence は同僚や読者を魅了する

Confluence のページを同僚と共有することは簡単です。 ドキュメントのページの最新版をクリック数回で共有することができます。 K15t では、スタッフが自分の洞察を共有する方法として、ページにコメントを残すことがよくあります。 ページを見ている全員が、コメントが追加されたときに通知を受け取ります。

しかし、Nils 氏の Confluence のお気に入りのソーシャル機能は、Facebookの「いいね」に似た「いいね」ボタンだそうです。 ユーザーは「いいね」をクリックして、ページ上のすべてが正しく、これ以上の改善は必要ないことを確認します。

Confluence のようなウィキは、テクニカル ライターにしか適していない典型的なヘルプ執筆プラットフォームよりもはるかに簡単に誰でも共同作業を行うことを可能にします。 企業がウィキ方式を採用しないほとんどの場合、コンテンツは他の部署の同僚がレビューするために CMS からエクスポートされなければなりません。 そして、彼らが作業を終えると、注釈や変更要求を再インポートし、手作業で処理しなければなりません。

#4 – Confluence はウェブベース

Confluence で作業するためにコンピューターに何かをインストールする必要はありません。 必要なのは、お気に入りのウェブブラウザ (Chrome や Firefox など) と個人用のユーザーアカウントだけです。 すべてのコンテンツは企業の Confluence サーバーで一元管理されますが、Confluence Cloud でクラウドルートを利用することも可能です。 つまり、会社の誰もが最新の情報にアクセスでき、本社、支店、出張先など、いつでもどこでもコンテンツを更新、共有、貢献できるのです」

Nils は Confluence のウェブベースのアプローチのファンです。 「Confluence は管理者が更新しなければならない唯一のコンテンツ管理ツールだからです」

#5 – Confluence はコンテンツ作成時に完全な透明性を提供する

Wikiベースのコラボレーションの背後にある考えは、誰もが貢献でき、内部の知識に自由にアクセスできるようにすることです。 ユーザーはページを見比べ、最新の企業知識で武装し、コンテンツがどのように進化していくかを観察することができます。

しかし、すべての従業員と情報を共有することが意味をなさない場合もあります。 このことを念頭に置いて、Confluence ではアクセスを制限することができ、きめ細かな権限と役割の管理を備えています。 たとえば、各ページやスペースにコメントを残したり、読んだり、編集したりできるのは誰なのかを簡単に定義できます。 しかし、拡張可能なプラットフォームであり、技術文書のコンテンツ管理などのユースケースに適合する膨大な数のアプリがあります。 例えば、Scroll Versions は Confluence Server と Data Center に同時バージョニングとバリアント管理をもたらし、本格的な CMS と使いやすい wiki の間のギャップを埋めてくれます。 Confluence Cloud ユーザーであれば、Scroll Documents により、ドキュメントチームとしてバージョンの管理、変更の追跡、コンテンツ開発ワークフローの管理を行うことができます。

ニルスはこう付け加えます。 「この Confluence 用のスクロールアプリなしで仕事をすることはもう考えられません。 手作業でヘルプ コンテンツをコピーして管理する代わりに、執筆に時間を費やすことができるのです。

Confluence に独自のヘルプセンターを構築した方法と理由をウェビナーでご覧ください。

#7 – Confluence はアジャイル環境に最適

多くのソフトウェア企業と同様、K15t はアジャイル開発パラダイムに従います。 サポート ドキュメントは、製品のように、スプリントやリリースの中で反復的に進化します。 リリースサイクルがますます短くなるにつれ、テクニカルライターもそれに歩調を合わせる必要があります。 これは、チームの全員が同じツールで作業し、情報を提供し、ヘルプコンテンツに即座にフィードバックを与えることができる場合にのみ可能です。

Nilsは、ドキュメントをリリースするための彼のワークフローを説明しています。 「私はドキュメントの次のバージョンに取り組み、開発者が製品のリリースをドアから出すとき、私は Scroll Versions を使用してヘルプ コンテンツを公開し、更新するだけです。 数回クリックするだけです。」

ご質問があれば、遠慮なく [email protected] .

にメールを送ってください。