かつてテクニカルライターはMS Wordなどのワードプロセッサを使用していました。しかし、使い勝手が悪く、ここ10年ほどで技術文書のほとんどがオンラインドキュメントツールに移行するようになりました。オンラインドキュメントツール(ヘルプオーサリングツールとも呼ばれます)を使用すると、テクニカルライターはドキュメントをオンラインに保存できるため、作成者、チーム、そして読者はインターネット接続とブラウザさえあれば簡単にアクセスできます。ソフトウェアドキュメントツールの好例の一つがClickHelpです。しかし、このようなツールのメリットはオンラインドキュメントの保存だけではありません。ここでは、ClickHelpがテクニカルライターにとって革新的なソフトウェアソリューションである理由を説明します。
ビジネス上のメリット
ClickHelpはブラウザベースの100%クラウドツールであるため、ドキュメントはサーバー上に保存されます。つまり、インストールは一切不要で、デバイス(スマートフォンやタブレットでも使用可能)とインターネット接続があれば作業は完了です。Microsoft Windows、Mac、Linux、Firefox、Safari、Chrome、Internet Explorerなどのブラウザで作業できます。そのため、チームメンバー全員が1つのポータルで連携し、必要な情報を見落とすことなく作業を進めることができます。適切なバージョンのユーザーマニュアルを探す必要はなく、ドキュメントの作成、レビュー、公開に集中できます。これにより、時間とコストの節約につながります。


さらに、ClickHelpは幅広いビジネスモデルを提供しており、柔軟性が高く、あらゆる予算に対応できます。例えば、標準プランは月額63ドル(年払い)で、作成者3名、レビュアー15名、トピック数300件が含まれます。また、ニーズに合わせてカスタマイズすることも可能です。
アジャイルテクニカルライティング
ドキュメントチームの作業負荷は、主に開発者に依存します。突然の機能変更は、ドキュメント全体に大きな変更をもたらす可能性があるからです。その結果、ユーザーマニュアルは断片的に作成され、誰かがボトルネックになる可能性があります。他のツールを使用すると、チームメンバーがプロジェクト全体を更新するまで待たなければなりませんが、ClickHelpではアジャイルなテクニカルライティングが可能で、準備が整ったトピックを即座に公開できます。仕組みは以下のとおりです。
- トピック フィルターの横にある積み重ねられた論文のアイコンをクリックし、ドロップダウン ボックスの [公開するトピックを選択...]オプションに進みます。

- 更新するトピックを選択してください。

- 選択したら公開をクリックします。

- 公開ウィザードウィンドウが表示されます。必要に応じて公開設定を行ってください。

これだけです!チームメンバーを待つ必要がなくなり、コンテンツをより早く配信できます!
ブランディングの可能性
ClickHelpでは、ニーズに合わせてドキュメントポータルをブランディングできます。ClickHelpは、すぐに使える様々なプロジェクトテンプレートを提供しています。例えば、APIドキュメントテンプレートはこちらです。

このテンプレートは、各パブリケーションに大きなアイコンとタイポグラフィを採用しており、ドキュメントを明瞭でプロフェッショナルなものにするのに役立ちます。ただし、これらの既成のスタイルに限定されるわけではありません。ドキュメントポータルのブランディングを自由にカスタマイズできます。以下は、ミニマルなブランディングの例です。

ClickHelpのユーザーマニュアルでは、CSSを知らなくても、ドキュメントポータルのブランディングに関する明確な手順をご覧いただけます。より複雑な設定をご希望の場合は、ClickHelpチームが喜んでお手伝いいたします。
結論
ClickHelpは、テクニカルライティングプロセスの生産性と効率性を向上させる、機能豊富なヘルプ作成ツールです。ぜひお試しください。無料トライアル(クレジットカードは不要)をご注文いただくと、以下の特典をご利用いただけます。
- パスワードで保護されたオンライン ポータル。
- すべての機能が含まれています。
- 著者アカウント10件。