書かずに伝える | 悪態のプログラマ

悪態のプログラマ

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

この季節、新入社員の書いた報告書を読む機会が多い。そんな中で特に気になることがある・・・と以前 にも書いたが、他にも気になることがある。

報告書に長い文を書いてしまう人が多いのだ。例えば、こんな具合だ。

今日は、○○機能の一覧画面と編集画面の設計を行いました。一覧画面は設計を終わらせてレビューまで完了しましたが、編集画面は設計途中で完成していません。

まぁ、言いたいことは分かる。

しかし、こうした文章を読んで理解するためには、多かれ少なかれ時間と労力が必要である。そして報告を受ける側の人間は、往々にして多忙なものである。

同じ内容を報告するなら、こんな風に書いてほしい。

本日の作業
  ○○機能
    ・一覧画面 ・・・ 設計、レビュー完
    ・編集画面 ・・・ 設計中

これなら、下手な文章を解読しなくても済む(※)。


長い文章をだらだらと書けば、「てにをは」を間違えたり、誤読の原因ともなる。なるべく文章を使わずに情報を伝えるテクニックを身に付けたいものだ。

例えば、適切な見出しをつけたり、箇条書きにしたり、といったことである。要するに、必要十分な言葉を紙面上にどう並べるかということを考えればよいのである。書く側にとっても、「文章」を考えるよりも楽なはずだ。

もちろん、文章でなければ表現できないような内容もある。しかし、そのような場合でも、なるべく文を短くし、見出しをつけるなどの工夫をすべきだろう。




※進捗報告としては、本当はもっと書くべきことがあるとは思うが。。。



報告書作成法―技術者必携!読み手をうならせる
野村 俊夫
日刊工業新聞社 (1999/01)
売り上げランキング: 19,660
おすすめ度の平均: 5
5 もっと早く買えばよかった
5 技術者必読!