ドキュメントへの「朱筆」について考える | 悪態のプログラマ

悪態のプログラマ

とある職業プログラマの悪態を綴る。
入門書が書かないプログラミングのための知識、会社の研修が教えないシステム開発業界の裏話は、新人プログラマや、これからプログラマを目指す人たちへのメッセージでもある。

SE の仕事では多くのドキュメントを作成する。その過程では、印刷したものを顧客や有識者にレビューしてもらったり、自分自身でチェックするようなことも多いだろう。そこで、修正すべきことがあれば、該当箇所に「朱筆」を入れる(もちろん、色は赤とは限らないが)。実際の電子ファイルは、後でその紙を見ながら修正することになる。

私の場合、開発チーム内ではレビュアーとなる機会も多いのだが、時々、この「朱筆」が漏れなく電子文書に反映されるかどうか、不安になることがある。

例えば、文書の枚数が多く、しかも修正すべきページがいくつもあるときだ。修正箇所がページの中に埋もれて忘れられてしまうのではないかと思う。該当のページに付箋を貼ればいいのだが、レビューに付箋を持参しない人も多い。余計なお世話かもしれないが、気になる場合には、私が自分の付箋を付けてやることもある。


また、1つのページ内に多くの修正が入ったり、修正には関係なく「覚え書き」のようなものを沢山書き込んだりして、ごちゃごちゃと読みにくくなってしまった場合も心配である。情報を書き込むこと自体は構わないのだが、後から見て、修正箇所が明確に分かるような工夫は必要だろう。

私自身が好んでやる方法は、修正箇所に「チェックボックス」を置くことである。といっても、目立つように四角形 "□" を手書きするだけだ。実際に電子ファイルを修正した時には、そこを1つずつチェックする(「レ点」を入れる)ことで、修正漏れはなくなる(※1)。

ドキュメントの修正作業は退屈なものだが、"□" にチェックを入れるという行為は、少し楽しい。まぁ、少しだけだが。

また、こうしておけば、「覚え書き」などの「ノイズ」が混じっていても、修正箇所を見つけやすい特定しやすいというメリットもある。"□" に注目して資料を眺めれば、修正が必要な箇所を見つけやすいのだ(※2)。


普段、資料への書き込みなどは何気なくやっているが、改めて考えれば、まだまだ工夫の余地はありそうだ。例えば、メモ用の領域を確保するために、余白を大きく取って印刷するというだけでも、かなり違うだろう(※3)。

また、レビュー時などでは「修正漏れを無くす」というだけでなく、「なるべく速く書く」という条件も必要だ。例えば、標準的な「校正記号」を覚えれば、もっと効率よく記入できるかもしれない。

いわゆる「ノート術」の一種になるのだろうが、ドキュメント作成の機会が多い SE には、こうした工夫をしていくことも重要かもしれない。




※1
最後にまとめてチェックすると意味がないので注意が必要だ。

※2
知覚心理学で「ポップアウト」という現象だ。私はチェックボックスに見立てて "□" を使っているが、"☆" や "◎" のような、もっと目立つ記号の方がいいのかもしれない。また、ペンの色を変えたり、スタンプのようなものを使うのもよさそうだが、持ち変える手間が増えるのがデメリットか。

※3
FinePrint icon のような印刷ツールを使えば、自分用の資料だけ余白を広げるようなことも簡単に出来る。



図解 百戦百勝のメモ術・ノート術―仕事、年収、昇格…人生は「書きグセ」で決まる!
本田 尚也
三笠書房
売り上げランキング: 30,785
おすすめ度の平均: 4
3 積極的にメモを取りましょう
5 メモることの効用
5 メモを使って能力アップ


校正記号の使い方―タテ組・ヨコ組・欧文組
日本エディタースクール
日本エディタースクール出版部
売り上げランキング: 7,871
おすすめ度の平均: 4
5 中学校で校正記号を教えたら
3 素人でも分かりやすい。