編集者ガチンコバトル「開発ドキュメント」に役立つ最新刊

2008年2月2日(土)
Think IT編集部

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

続いて紹介するのは、この連載に積極的に参加している毎日コミュニケーションズから、筆者にとっては「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 〜オープンソースから学ぶソフトウェア開発技法 ドキュメントの種類と見分け方を知る!
Code Reading 〜オープンソースから学ぶソフトウェア開発技法

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

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

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

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

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

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

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

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

“オープンソース技術の実践活用メディア” をスローガンに、インプレスグループが運営するエンジニアのための技術解説サイト。開発の現場で役立つノウハウ記事を毎日公開しています。

2004年の開設当初からOSS(オープンソースソフトウェア)に着目、近年は特にクラウドを取り巻く技術動向に注力し、ビジネスシーンでOSSを有効活用するための情報発信を続けています。クラウドネイティブ技術に特化したビジネスセミナー「CloudNative Days」や、Think ITと読者、著者の3者をつなぐコミュニティづくりのための勉強会「Think IT+α勉強会」、Web連載記事の書籍化など、Webサイトにとどまらない統合的なメディア展開に挑戦しています。

また、エンジニアの独立・起業、移住など多様化する「働き方」「学び方」「生き方」や「ITで社会課題を解決する」等をテーマに、世の中のさまざまな取り組みにも注目し、解説記事や取材記事も積極的に公開しています。

Think ITメルマガ会員登録受付中

Think ITでは、技術情報が詰まったメールマガジン「Think IT Weekly」の配信サービスを提供しています。メルマガ会員登録を済ませれば、メルマガだけでなく、さまざまな限定特典を入手できるようになります。

Think ITメルマガ会員のサービス内容を見る

他にもこの記事が読まれています