良いマニュアルの条件をまとめると…

読みやすく、見やすく、伝わりやすい
読み手にとって理解しやすい書き方をされている
タスク流れが分かりやすくまとめられている
つまづきそうな点を予見して記載する
読み手の混乱を招かないように配慮する
アップデートする

などが挙げられます。

もう少し分解してみましょう。

1. 読みやすく、見やすく、伝わりやすい

見出しや改行、注釈などスタイルが共通している
画像が適切に貼られていて、文字を読み飛ばしてしまってもある程度、理解できる
文体が統一されている

ガタガタになったラインや、統一されていないスタイル・文体は、読み手に余計な情報処理を要求することになります。

また見づらい文体は理解もしづらい。

タスクの理解に集中してもらえるように、画像の使い方や本文のスタイルには気を遣いましょう。

2. 読み手にとって理解しやすい書き方をされている

読み手の知識レベルや経験に合わせた言葉を使用している
専門用語や略語を多用しない（プルリクをPRと略すなど）
社内でのみ使われている用語には必ず注釈をつける

読み手が新人なのか、ある程度の経験者なのかによって、言葉のチョイスが変わります。

基本的には、まっさらな新人が読んでも問題なくタスクが完了できるように丁寧に書くのが良いでしょう。

また、略語を使うことで文字量を減らすことはできますが、略語が出てくるたびにその意味を思い出す必要があります。

人の頭のメモリはそんなに多くないです。

余計なことで集中を途切れさせないようにしましょう。

（社内用語も同じ。）

3. タスクの流れが分かりやすくまとめられている

手順と結果の因果関係を明確に示す
クリックする場所は画面を広範囲でキャプチャして、赤枠をつける（ボタンの画像のみだと、どこにあるボタンなのか分からない）
「これくらいわかるだろう」は禁止

私も気をつけていますが、「クリックしたらどうなるか」の画面を飛ばしがちです。

マニュアルでは書かれていない画面が突如現れると読み手は混乱します。

余計な混乱を招かないように、手順は飛ばさずに書きましょう。

また、マニュアルを書いているうちにタスクの流れ全体を見直したほうがいいと気付くこともあります。

その時は、一旦そのタスクのやり方自体を見直してみましょう。

4. つまづきそうな点を予見して記載する

マニュアルを書いていると自分が初めて教わった時につまづいた点を思い出します。

そういったところはポイントとして別枠で記載して、読み手の不安を解消しましょう。

5. 読み手の混乱を招かないように配慮する

1〜4の全てに通じますが、人間の脳内のメモリはそんなに多くありません。

邪魔が入るとすぐに集中力が途切れてしまいます。

混乱しそうな部分はできるだけ排除し、タスク完了に集中してもらいましょう。

そのほか、下記のようなことも混乱を招く要因になりますので、避けたほうがいいと思われます。

本文中に参照リンクが多い。（１つのマニュアルでまとめましょう。）
「ここはやりやすいようにやってください」など、タスク未経験者に判断を委ねる

6. アップデートする

作ったマニュアルは、実際に作業してもらって、フィードバックをもらいましょう。

一度で完璧に作成することは難しいです。

しかも、慣れている人が作るマニュアルは、どうしてもそのタスクのことを分かってるから抜け漏れが発生しがち。

わかりづらいと指摘を受けた点は、修正をして、完璧なマニュアルに近づけましょう。

あれ？これってデザインと似てない？😳

本題です。

マニュアルを書くことって、実はWebデザインの流れと似てると思います。

読みやすく、見やすくすることは、UIデザイン
読み手の知識レベルに合わせることは、ターゲット設定
スタイルや文体の統一は、コンポーネント化の理論
タスクの流れの整理は、IA
不安や混乱を解消し、タスクを完了できるよう配慮することは、UX …

なんか似てません？？笑

いやいや、何を当たり前のことを。。。

と思われる方も多くいると思います。

恥ずかしながら、私は、全ての知識を繋げて考えることが苦手で、各ジャンルごとに知識や考え方を分断してしまうクセがあります。

応用が効かないんです。

なので、マニュアルを作成する時は、「マニュアル作成脳」に固定されてしまうので、なかなかヒドいマニュアルを作ったりしたことも過去何度もありました。

どう書けばいいかわからず、マニュアル作成が苦痛でw

しかし、デザインと同じだと考えるようになってからは、いかに読み手を不便や不安な思いをさせないマニュアルを書くか、ということが面白くなりました。

まとめ😊

マニュアル作成が苦手だ、面倒だ、と感じているデザイナーさんは

「業務マニュアルの作成は、UXデザイン思考の練習だ！」

と思って作成するのも良いかもしれません。

今よりは、楽しくなる、、、はず！

そして、完璧なマニュアルでルーチンタスクの負担を減らし、よりクリエイティブに専念できる環境を整えていきましょう！

それにしても、、、

このブログテンプレート、なんで記事タイトルより<h2>が大きいんだろう…

2017.12