手順／仕様説明などをする際に 「Ａの場合は・・・Ｂの場合は・・・」 のように基本は同じでも場合によって少し違う説明が必要なときがあります。
このような場合、 「コピペして違う部分だけ直す」 という方法をとりがちですが、それだけだと読者に大きな負担を与える、分かりにくい説明になりやすいので注意してください。
先日20数人の図解宿題の添削をしていたところ、1/4の6人の解答でこのパターンを発見したぐらい、よくあるものなんです。これも自然な発想でしてしまうことなので、「やっちゃいけない」と教えられていないとなかなか気がつきません。
このやり方、書く方はコピペ＋修正で済むので楽です。コピペした本人だからこそ、「修正した部分以外は同じ」と知っているので同じ部分をわざわざ読み比べたりはしません。ですが、それを知らない読者は「だいたい同じに見えるけれど、もしかしたら微妙に違うかもしれない」と不安になり、似た部分をいちいち全部見比べなければならないので、とても疲れてしまうわけです。書いた本人はこれに気がつきません。
↓↓↓
↓そんなわけですので、違う部分を目立たせるようにしましょう。
↓「同じ情報を二度書かない」ようにするのも良い方法です。
↓「標準的にはＡだが、例外的にＢとする場合がある」といった業務フローがある場合、標準側を真っ直ぐ、例外系を脇道として書くのが基本です。
↓例外処理とバグはハッキリ区別しておくべきです。
↓バグを注釈として書く方法。
↓バグ発生後のフローを完全に切り離す方法。
コメント