ヘルプサイトの作り方

ユーザーの「わからない」を解消してプロダクトの価値を高める。機能と操作手順を正しく伝えるためのテクニック。ヘルプサイトは「仕様書」ではありません!

『ヘルプサイトの作り方』 (仲田尚央、山本絵理 著、技術評論社、2019 年 2 月刊) は、ヘルプサイトをサイト全体の設計から記述方法、検索で見つけやすくする方法、ユーザーのフィードバックを受けての改善方法まで扱う WEB+DB PRESS plus シリーズの 1 冊です。版元の著者紹介によれば、仲田尚央と山本絵理はいずれもサイボウズのヘルプ制作チームでテクニカルライターとして、製品のヘルプやマニュアルの制作、製品画面のメッセージ設計に携わってきました。書誌の紹介文には、ヘルプサイトは仕様書ではないとあります。

全 10 章の構成、ペルソナ設定から運用の仕組みまで

第 1 章「ヘルプの基本」でヘルプの役割と良いヘルプの要素、制作の流れを示したあと、第 2 章「誰に何を伝えるかを整理する」でペルソナの設定とプロダクトの仕様に関する情報の集め方を扱います。第 3 章「ユーザーの使い方を意識して構成を設計する」はユーザーの情報の探し方とサイトマップの作成、カテゴリー構成、記事のタイトルの決め方を、第 4 章「ユーザーの動線からナビゲーションを設計する」はトップページやモバイル、プロダクトの画面からの導線を取り上げます。第 5 章「スタイルガイドや用語集を準備する」で表現と用語の統一を固め、第 6 章は「記事を作る」を主題に文章と図解のテクニックを、第 7 章「記事を検索最適化する」は記事と HTML の両面の検索最適化を扱います。第 8 章「データからヘルプを改善する」と第 9 章「ユーザーテストでヘルプを改善する」が公開後の改善にあたり、第 10 章「アジャイル開発に対応するヘルプ管理システム」で終わります。

情報探索の 4 つの行動モデルと、検索最適化の章

本書の第 3 章は、既知項目検索、探求探索、再検索、全数探索という情報探索の 4 つの行動モデルから話を始め、記事のタイトルをユーザーが使うキーワードに合わせる節を置いています。セマンティック HTML は、見出しや強調、警告文を見た目の装飾ではなく要素の意味で示す HTML の書き方で、第 7 章は記事と HTML の両面の検索最適化を扱います。第 7 章にはリッチエディターのデメリットや、リッチスニペットで検索結果に記事のカテゴリーを表示する方法を扱う節があります。

アクセスログとユーザーテストによる改善、Markdown と Git の運用

第 8 章はヘルプの KPI として、アンケートの回答結果、平均解決時間、検索結果ページでの離脱率、結果が 1 つも返らない検索の割合を挙げ、アンケートとアクセスログの集計から改善点を探し、Google データポータルで集計レポートを自動で作る手順まで進みます。第 9 章はカードソーティングによる記事分類のテストと、思考発話を使ったナビゲーションと記事のテストを扱います。第 10 章は記事をマークダウン記法で書き、バージョン管理システムで管理し、プルリクエストで記事をチェックする仕組みと、翻訳支援システムや機械翻訳との連携、GitHub のブランチを使った公開の流れを扱います。Markdown は、見出しや箇条書きを記号で書くプレーンテキストの記法です。フィーチャーブランチ は、機能ごとに切る Git のブランチで、作業の後に本流へ合流させます。版元は対象として、ヘルプサイトをユーザーにとって使いやすいものにしたいと考えている作成者と、自分の開発したプロダクトの魅力を伝えられるヘルプサイトを作りたいと考えているエンジニアを挙げています。扱うのは Web 上のヘルプサイトの設計と運用であり、紙の取扱説明書の組版や印刷の工程は目次に含まれていません。本書は、ヘルプの設計、記事の書き方、検索最適化、データとユーザーテストによる改善、アジャイル開発に合わせた運用の仕組みまでを全 10 章に収めています。