ドキュメント作りで一番大切なのは、相手に考えさせないこと

野村 輝のプロフィール画像
エンジニア 野村 輝

329 view

サイトを更新するための資料を作成したときのこと。

この手のマニュアルのような資料は、単純に手順を整理して示すだけでなく、どうすれば担当者の作業の負担を軽減し、誤解なく、ミスなく、作業を完遂できるかを考えなければならない。

わたしの考えでは、一番大事なのは「相手に考えさせないこと」である。

慣れない作業をおこなうときの一番のストレスは、不安感である。選択肢はなるべく与えず、シンプルに一つの方法を順番に示すことで、迷いなく作業を進めることができる。

例えば、こういう方法もあるけど、別の方法もあるよ、やりやすい方を選択してね!という表現は、一見親切そうに見えるが、作業が慣れていない人にとっては、迷ってしまうポイントになる。

そのシステムを作った人は、機能のすべてを熟知しているがゆえに、あれも、これもと、すべての機能を説明しようとしてしまう。でもこれが、分かりにくさ、不安の一番の要因になる。

例えば、電化製品などで、マニュアルが難しく、結局読んでもらえず、お問い合わせやクレームが全然減らなかったら、そのマニュアルを丁寧に時間をかけて作った意味がない、となってしまうが、それと同じことである。

ドキュメントの一番の目的は、仕様を文章にまとめることではない。それを読む人とのコミュニケーション。利用する人のことを考え、ストレスや不安感を感じさせず、ミスを誘発しないドキュメント作成を、これからも心がけたい。

関連する日報

    健全メンタルで仕事をするための4つの秘訣

    6,737 view

    高橋 慶のプロフィール画像
    高橋 慶 コンサルタント
    他責的な思考に陥らないためのヒント

    1,991 view

    山川優理子のプロフィール画像
    山川優理子 デザイナー
    ベイジに転職して二か月のディレクターが感じた、フルリモートで築かれる職場文化

    580 view

    川向健太のプロフィール画像
    川向健太 コンサルタント
    Slackで組織カルチャーを作る!当社の自作スタンプ活用例

    2,328 view

    古口 真凜のプロフィール画像
    古口 真凜 バックオフィス
    「ゆるふわ会議」撲滅法

    1,331 view

    野上 恵里のプロフィール画像
    野上 恵里 コンサルタント
上に戻る