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

野村 輝のプロフィール画像
情報システム 野村 輝

387 view

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

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

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

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

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

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

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

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

関連する日報

    結局、わからないことは聞くしかない

    511 view

    荒川翔太のプロフィール画像
    荒川翔太 プロデューサー
    見慣れない仕事道具が、独自性の高いコンテンツになる

    709 view

    本山 太志のプロフィール画像
    本山 太志 プロジェクトマネージャー
    職場に「楽しさ」って必要?

    1,024 view

    西岡 紀子のプロフィール画像
    西岡 紀子 コンテンツディレクター
    自分を客観視できていると言い切れるか

    494 view

    仲野翔也のプロフィール画像
    仲野翔也 営業
    生成AI時代に信頼される人の気遣い術

    662 view

    奥原美穂子のプロフィール画像
    奥原美穂子 経営企画
上に戻る