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

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

283 view

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

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

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

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

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

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

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

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

関連する日報

    「答えにくい質問」をやめるコツ

    1,732 view

    川名子 紗依のプロフィール画像
    川名子 紗依 デザイナー
    名前が変われば会議が変わる

    5,268 view

    西岡 紀子のプロフィール画像
    西岡 紀子 ライター
    通知のマネジメントも自己責任の時代

    7,301 view

    枌谷 力のプロフィール画像
    枌谷 力 代表取締役
    ライターに力を発揮してもらうコミュニケーションのコツ

    1,400 view

    鈴木はる奈のプロフィール画像
    鈴木はる奈 ライター
    それ、本人に直接言っちゃいなよ

    8,819 view

    枌谷 力のプロフィール画像
    枌谷 力 代表取締役
上に戻る