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

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

347 view

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

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

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

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

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

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

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

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

関連する日報

    出社なしでも成り立つ?ベイジのフルリモート文化

    1,238 view

    安齋実咲のプロフィール画像
    安齋実咲 ディレクター
    上司のフィードバックがしっくりこない時に知っておきたいこと

    9,374 view

    菅野 黎樹のプロフィール画像
    菅野 黎樹 エンジニア
    チームの生産性を上げる「適切に頼る力」

    651 view

    吉池千尋のプロフィール画像
    吉池千尋 ライター
    どうやって不安と向き合う?社員が実践する4つの方法

    1,273 view

    古口 真凜のプロフィール画像
    古口 真凜 バックオフィス
    "でしゃばり"が組織にもたらす価値

    814 view

    若菜 真穂のプロフィール画像
    若菜 真穂 コンサルタント
上に戻る