『エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方』

ある意味、私の原点となるモノが凝縮されていると思う書籍。ようやくお披露目することが出来ました。

エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方

本書の元になったのは、『開発の現場 vol.006』に寄稿させて頂いた「Wordを駆使した賢いドキュメントの作り方」という記事です。この記事では「ドキュメントは1が見栄え、2がメンテナンス性、中身はそれから」という掛け声の元、Word を効果的に利用する技法を紹介させて頂きました。本書はその内容を大幅にブラッシュアップしたものです。

開発者の多くは Word が嫌いです。しかし私が見たところ、Word が嫌いと言う開発者で、Word を本当に知っている人はいません。どこででも使える効果的なツールでありながら、機能が豊富なために「使いづらい」と思われてしまっている現実、そしてドキュメント作成ツールとして Word を選ばなかったばかりに無駄な作業に忙殺されるエンジニア…その現状を何とかしたいと考えたのが上記記事、そして本書の(元々の)執筆動機です。

とは言え、本書で最も伝えたかったことは、ソフトウェア開発の現場でのコミュニケーションにまつわる問題です。コミュニケーションにはコストがかかりますが、そのコストについて意識している開発者は決して多くありません。しかし、メリットに見合わないコストをかけるという行為は常に悪です。効果的なコミュニケーションとは何か、その手段としてドキュメントが最適な方法なのであれば、そこにまつわるコストを最小化する為にはどうすればよいか…本書ではそのような「真に効果的なドキュメントを作成する上での背後にある考え方」について解説しています。

ソフトウェア開発には、同じものは存在しません。ですから、本書では「このようなドキュメントではこういったことを書かなくてはならない」といった内容は一切説明していません。書いてあることはただ一つ、「良いドキュメントを作成するための原理原則」だけです。しかしその原理原則は、必ずや効果的なコミュニケーションを実現するためのヒントになると信じています。