ヘルプサイトの作り方

はじめに

この記事を読むのに必要な時間:およそ 1 分

プロダクトの数だけヘルプがあると言っても過言ではないほど,ヘルプはプロダクトに欠かせないものです。ヘルプがなくても使えるプロダクトにすることが理想ですが,現実的には困難でしょう。筆者らが所属しているサイボウズが開発するグループウェアのように大規模なプロダクトでは特に,プロダクトの使いこなし方をユーザーに伝える上でヘルプなどのドキュメントは必要不可欠です。

ヘルプには日々膨大なアクセスがあります。ヘルプへのユーザーのアクセス数は,プロダクトのプロモーションサイトより多くなることも多いでしょう。ユーザーがプロダクトに関わる時間は,購入検討時よりも購入後のほうが長いからです。特に,近年増えているサブスクリプションモデルのプロダクトでは,ユーザーにプロダクトを利用し続けてもらうためのフォローが重要になります。ヘルプはユーザーと継続的に関わる大きなタッチポイントであり,ヘルプの満足度はプロダクトの満足度に大きく関わります。

では,どうすれば満足度の高いヘルプにできるのでしょうか? この本を読もうとしている方の中には,文章を書くことに不慣れな方もいると思います。ですが,ヘルプの文章を書くのに文才がいるわけではありません。ユーザーがヘルプに不満を抱く原因は,探している情報が見つからないこと,逆に情報が多すぎて読むストレスが大きいこと,使われている言葉の意味がわからないことなどに依る場合がほとんどです。そのため,⁠誰に何を伝えるか」⁠情報をどう探させるか」という設計をしっかり行うことが重要であり,多少の文法の間違いは問題になりません。このような理由から,本書では,コンテンツを作る前に行うヘルプ全体の設計に重点を置いて解説するようにしました。

また,本書はWebサイトとして作るヘルプに特化して解説しています。Googleなどの検索サイトの利用が一般化した現在では,ユーザーはヘルプにアクセスして必要な情報を探すのではなく,検索サイトで検索して情報を探すことが多くなりました。実際,サイボウズのヘルプでも,約半数のユーザーは検索サイトを経由してヘルプにアクセスしています。Webサイトとしてヘルプを作ることで,ユーザーは検索サイトを使って情報を探しやすくなります。

Webサイトとしてヘルプを作ることには,ヘルプにアクセスしたユーザーの足跡(アクセスログ)を確認できるというメリットもあります。ヘルプは作って公開することがゴールではありません。使いやすく役に立つヘルプにするためには,公開後の継続的な改善こそが大切です。改善しようとしてもどこから手をつければよいのかわからなかったり,改善施策を打ったものの,効果があったのかわからなかったりすることも多いと思います。本書では,効果を確認しながら効率良くヘルプを改善していくためのノウハウも解説するようにしました。

さらに,近年広がるアジャイル開発に対応するために,プロダクトの仕様変更やリリース計画の変更に柔軟に対応し,素早くヘルプコンテンツを制作し公開していく運用について,サイボウズでの運用例も取り上げます。アジャイル開発では,開発期間が短縮され,新機能や機能改善が高頻度にリリースされます。それは,ヘルプにとってはコンテンツの制作にかけられる期間が短くなることを意味します。また,プロダクトの仕様変更やリリース計画の変更への対応も必要になってきます。

なお,本書の内容は決して筆者だけで学び得たものではなく,サイボウズのヘルプ運用チームが得たノウハウを凝縮したものです。素晴らしいチームメンバーに感謝します。特に,レビューに協力してくださった近藤有紀さんには深く感謝します。また,執筆中の長い間,根気強くサポートしてくださった技術評論社の池田大樹さんに感謝します。最後になりますが,長い執筆期間中ずっと支えてくれた家族と友人に感謝します。皆様の支えがなくては,本書を書き上げることはできませんでした。

本書がヘルプをより使いやすく役に立つものにする一助になれば幸いです。

2019年1月 仲田 尚央

著者プロフィール

仲田尚央(なかたなおひろ)

サイボウズ株式会社にて,システムエンジニア経験を経て,ヘルプ制作チームでテクニカルライターとしてサイボウズ製品関連の技術情報発信,ヘルプやマニュアルの制作,製品画面のメッセージ設計などに従事。Webサイトの設計から,コーディング,ライティング,アクセスログ分析まで幅広く取り組む。現在はチームマネージャーとして,多言語の大規模Webサイトを効率的に運用する仕組み作りに注力中。