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

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

393 view

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

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

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

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

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

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

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

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

関連する日報

    結局、図式化は日本語だと思う

    73 view

    平城 舞子のプロフィール画像
    平城 舞子 プロジェクトマネージャー
    「褒めるのが苦手」なら、感謝を伝えてみる

    379 view

    竹村 恵のプロフィール画像
    竹村 恵 バックオフィス
    オタク気質の人が仕事で伸びやすい理由を考えてみた

    327 view

    五ノ井 一平のプロフィール画像
    五ノ井 一平 コンテンツディレクター
    「自作AIドリル」で執筆力を鍛える

    534 view

    星山かなたのプロフィール画像
    星山かなた コンテンツディレクター
    結局、わからないことは聞くしかない

    718 view

    荒川翔太のプロフィール画像
    荒川翔太 プロデューサー
上に戻る