コードを読んで、ドキュメントも書こう！

コードを読んで、ドキュメントも書こう！

続いて紹介するのは、この連載に積極的に参加している毎日コミュニケーションズから、筆者にとっては「Codeものの編集者」というイメージが刷り込まれつつある西田 雅典さんが送り出した「Code Reading」だ。

西田さんは、「Write Great Code」シリーズや「Write Portable Code」「FreeBSD fan Vol.1」「玄箱の本」「改訂第2版 ケータイHTMLコンパクトリファレンス」「ドキュメントハックス−書かない技術」などなど、多数の書籍を手がけている。

その西田さんが今回紹介してくれる1冊は、「Code Reading 〜オープンソースから学ぶソフトウェア開発技法」だ。

この書籍は「土日に買って勉強したい『バグ管理』本」の「第1回：編集者ガチンコバトル『バグ管理に役立つ最新刊』」で紹介した、「Code Craft 〜エクセレントなコードを書くための実践的技法〜」そして「Code Quality 〜コードリーディングによる非機能特性の識別技法」の前段に当たる。

それではその内容に迫っていこう。

ドキュメントの種類と見分け方を知る！
Code Reading 〜オープンソースから学ぶソフトウェア開発技法

著者：Diomidis Spinellis、トップスタジオ（訳）、まつもとゆきひろ（監修）、平林俊一（監修）、鵜飼文敏（監修）
発行：毎日コミュニケーションズ
ISBN：978-4839912659
仕様：544ページ
価格：5,460円（税込み）
発売日：2004年05月31日

「一般的なドキュメント」以外のドキュメントとは？

「『Code Quality 〜コードリーディングによる非機能特性の識別技法』に先立って刊行された本書は、文字通り『コードを読む』ことに観点を置いている。

ここでいう『コード』とは、ソースコードのみを指すのではなく、ソフトウェアプロジェクトを構成するすべての要素、具体的には、（コメントを含む）ソースコード、ドキュメント、実行可能なプログラム、設定スクリプトなどを指している。

もちろん、読む対象として主に取り上げられているのはソースコードについてではあるが、ドキュメントについても1章を割き、その種類や読み方、さらには含有している問題点が取り上げられている。

また、一般的に考えられるドキュメント以外にも、たとえば、ソースコードの中のコメントやリビジョン管理システムのコメントなど、さまざまな『ドキュメント』があること。そして、その見分け方なども解説されている」

シンクイットでも大人気のRubyの開発者、まつもとゆきひろ氏も参加したこの1冊。ぜひ「Code Craft 〜エクセレントなコードを書くための実践的技法〜」と「Code Quality 〜コードリーディングによる非機能特性の識別技法」と共に読んでもらいたい。

さらに西田さんからもう1冊、開発ドキュメントを書くときにも使える「書くテクニック」が満載の新書、「ドキュメントハックス−書かない技術」を紹介していただこう。