開発ドキュメント作成に役立つ書籍たち
UMLモデリングを始める前に読みたい1冊
「論理トレーニング」と同様、坂田氏が推薦してくれたのが「UMLモデリングのエッセンス 第3版」だ。
「次に紹介する『UMLモデリングのエッセンス』は、開発ドキュメント作成という立場からみて参考になる書籍です。この本は前述したドキュメント作成のために重要な1つ目のポイント『他人に何を伝えたいのかを自分で明確に把握し理解する』を達成するために役立つ名著です。
世の中にUMLの記述形式を紹介する本は数多くありますが、自分が何をモデリングし、どのようにUMLで表現すべきかという観点から書かれた本の中で、本書は最良の入門書であることは間違いありません。
すでにUMLを用いてドキュメントを作成している方もこの本を読んで再度UMLの本質をつかんでいただければと思います」
Nexedi 最高技術責任者奥地 秀則
オープンソースERP「ERP5」の設計・開発に初期段階から関与し、現在ERP5の技術責任者を務める。服飾業、金融業、鉄鋼業、自動車産業、航空宇宙 産業におけるERPプロジェクトを経験してきた他、社内外のエンジニアやコンサルタントのトレーニングを指揮している。
プログラミング作法
著者：Brian Kernighan、Rob Pike、福崎 俊博（翻訳）
発行：アスキー
ISBN：9784756136497
仕様：355ページ
価格：2,940円（税込み）
発売日：2000年11月
そのままドキュメントになるコードを書こう！
続いて「ERPに新勢力登場！オープンソースERP」でERP5について解説していただいた奥地氏の紹介する1冊だ。
「ソフトウェア開発でもっとも悩ましい問題、それはドキュメントを読むことです。できることなら読みたくない、でも必要とする時にないと困る、これが多くのエンジニアが心に抱いている正直な気持ちではないでしょうか。私もそうです。
そういう少々怠惰なエンジニアが理想とするのは、ソフトウェアのコードがそのままドキュメントの代わりになってしまうことです。『読んでそ のまま理解できるコードを書くこと』これが出発点。ドキュメントには、コードを読んだだけではどうしても理解しづらい部分にだけ、すっきりとした的確なコ メントが付いていてほしいですよね。
そういうあなたにぴったりなのがKernighan、Pikeという著名人によって書かれた本書、『プログラミング作法』なのです。
特に私のように情報科学出身ではない場合、独力で適切な作法を身につけるのは大変です。本書ではプログラミング全般を扱っていますが、一章 ではコメントの書き方に紙面を割いており、『悪いコードにコメントをつけるな、書き直せ』など、短いながらも極めて適切なアドバイスが掲載されています。
昨今では、ドナルド・クヌースによって考案された文芸的プログラミングに触発され、pydoc、Doxygen、podなど、ソースコード のコメントからドキュメントを生成するツールが広く使われています。本書を一読すれば、きっと的確なコメントの書き方が身につくはずです」
コードからそのままドキュメント生成できれば、開発工数がかなり削減されるだろう。すっきりしたコードはプログラマならぜひ身につけたい作法だ。
