ユーザーのことを全く考えていないマニュアルを改訂した

2年くらい前に自分が作った社内向けマニュアルを見直したら、めちゃくちゃ読みづらく、穴があったら入りたい気分でした。
具体的には：
・ユーザーが情報を探しづらい
・記述のルールが統一されていない
・以前のシステムを知っている人にしか通じない表現
などなど、欠点だらけのマニュアルでした。
本記事では「旧マニュアル」と呼びます。

これを修正し、多少マシにしたのが「新マニュアル」です。
・ユーザーの目的ごとに章構成を整理
・記述ルールを統一
・新規メンバーが難なく理解できる表現

マニュアルに限らず、今後「ユーザーに理解してもらう」ためのものを作るときに同じミスをしないよう、何をどう修正したかまとめておきます。

どんなマニュアルか

オンラインの勤怠管理システムのマニュアルです。
自社システムではなく、既存サービスを導入しているため、基本マニュアルはサービス提供会社のwebサイトで見ることができます。
しかし、会社の制度に基づいた独自の運用ルールが多いため、社内のマニュアルを作成していました。

載せる情報を整理するプロセス

まず、マニュアルに載せる情報を整理するプロセスを変えました。

古いバージョンの作成プロセス
・先にシステムを試用していた管理者から説明を受ける
・システムの画面ＵＩに基づいて章を分ける

社員が実際に使う前だったので、機能をよく知っている管理者から話を聞くのがベストと思っていましたが、管理者とユーザーではやはりシステムへの姿勢が違いました。また、機能をよく知っているために、「初心者がどう思うか」という視点が抜け落ちやすかったと思います。

今回の修正プロセス
・管理者によく寄せられる質問を整理
・新規メンバーにアンケート実施
（使い始めて最初に疑問に思った点、質問した点など）
・ユーザーがマニュアルを開く目的を整理

問題点①カテゴライズの意図が不明

まずこちら、旧マニュアルの章タイトルの一部です。
5章：各種確認
・有給確認
6章：給与確認

なぜ「各種確認」の章の中に「有給」と「給与」を入れなかった？？？
かなり謎ですが、「有給と給与は別のもの」という考えがベースにあったように思います。
（それならせめて章のタイトルを「5章：有給」「6章：給与」とすれば整合性はとれていましたが…）

今回は以下のように修正しました。
5章：情報を参照する
　ー給与明細を見る
　ー有給情報を見る

各タイトルを「〇〇を〇〇する」という形にできたのは良いですが、ただ「情報を参照する」という章タイトルがストレートに頭に入ってくるか少しあやしい気もします。
ここは今後、ユーザーである社員の声を聞きつつ、アップデートしていけたらと思います。

問題点②：それどういう意味？

ぱっと見で頭に入らない言葉

各種確認
先述の謎カテゴライズですが、章タイトルの言葉も問題でした。
「各種」とは？？
強いて言えば、「この章のなかにいろんな情報が入ってるよー」という意味ですね。「等」「etc.」のようなものかと思います。
具体的な内容はその一段下の小見出しを見なければ分からないため、「各種」は不要と判断し、以下のように修正しました。

・各種確認　⇒　情報を参照する
・各種申請　⇒　休暇を申請する

締め作業
毎月末に、各ユーザーが自分の勤務実績に間違いがないかチェックする作業があります。
そして、確認が完了したことを示すために、勤怠システム上で表示される実績一覧にチェックマークを入れ、更新ボタンを押す、という運用ルールがあります。

これを旧マニュアルでは「締め作業」と呼んでいました。
しかし、これは経理の人が使っていた表現で、システム内にも出てこなければ、社内で浸透した表現というわけでもありません。
（そもそも、社内で浸透した言葉があったとしても、新しく入ったメンバーが読むマニュアルに使用すべきではありませんね。）

さらに、システム上で押すボタンは「更新」、情報を送信するという意味では「申請」などなど、動詞が乱立していました。

今回、章タイトルを以下のように修正しました。
・締め作業　⇒　月末の承認申請

しかし、「承認申請」という言葉だけでは、新規メンバーに直感的に理解してもらうのは難しいでしょう。
マニュアル内では、以下のようにして、理解しやすい書き方を試みています。
・まず「承認申請」がなんなのかを説明する
・マニュアル内では「承認申請」で統一し、他の表現は使わない

まわりくどい言葉

まわりくどい表現を多数修正しました。
・設定を行う　⇒　設定する
・クリックすることで自動で　⇒　クリックすると自動で
・休憩時間は設定されている時間と同じ　⇒　休憩時間は設定と同じ
・修正したい日の日付　⇒　修正したい日付
・本マニュアル内p.5に　⇒　本マニュアルp.5に

よりユーザーの視点に近づく

できるだけ、「ユーザーが主語になる」表現に修正しました。

例えば：
・○○の取り消し　⇒　○○を取り消す
・スマホからの申請　⇒　スマホから申請する

ビジネス文書として書こうとすると、どうしても「〇〇の取り消し」のような体言止めの表現が多くなる気がします。
しかし、ユーザーは「〇〇を取り消したい」と思ってマニュアルを開きます。「〇〇を取り消す」という表現の方がよりストレートに理解しやすいと思い、修正しました。
この観点でマニュアルを見直したら、体言止めがかなり多く使われていて驚きました。

もちろん、体言止めが悪いというわけではなく、使いどころ次第だと思います。
ですが、中には「スマホから操作する場合の休暇申請」のような表現もあり、これは「スマホから休暇を申請する」にした方がはるかにわかりやすくなりました。

今後はこまめに管理者やユーザーにヒアリングを行い、使いやすいマニュアルにアップデートしていきたいと思います。
そもそも、「わかりづらい」と思ったときにすぐに伝えてもらえる報告システム、関係の構築がまず必要だと考えています。