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

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

364 view

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

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

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

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

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

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

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

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

関連する日報

    技術に疎くてもわかるXのアルゴリズム解説:公開コードから読み解く仕組みとフォロワー増加戦略

    1,950 view

    枌谷 力のプロフィール画像
    枌谷 力 代表取締役
    「なんとなく放置」を卒業する4つのステップ

    682 view

    仲野翔也のプロフィール画像
    仲野翔也 営業
    「自信がある」は「実力がある」ではない

    1,412 view

    川道優輝のプロフィール画像
    川道優輝 コンサルタント
    自分なりの「楽しめる学び方」のススメ

    403 view

    若菜 真穂のプロフィール画像
    若菜 真穂 コンサルタント
    個人の学びを会社の財産に変える方法

    1,151 view

    古口 真凜のプロフィール画像
    古口 真凜 バックオフィス
上に戻る