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

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

350 view

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

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

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

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

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

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

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

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

関連する日報

    その「すみません」、ちょっと待った!

    226 view

    吉池千尋のプロフィール画像
    吉池千尋 ライター
    営業活動を支える、生成AIの活用シーン8選

    1,342 view

    仲野翔也のプロフィール画像
    仲野翔也 営業
    「弱みより強みが大事」の危うさ~パワプロ編~

    375 view

    五ノ井 一平のプロフィール画像
    五ノ井 一平 ライター
    ChatGPTを「インタビュアー」として活用する

    1,112 view

    新屋敷 章寛のプロフィール画像
    新屋敷 章寛 デザイナー
    出社なしでも成り立つ?ベイジのフルリモート文化

    1,612 view

    安齋実咲のプロフィール画像
    安齋実咲 ディレクター
上に戻る