『エンジニアのためのWord再入門講座』――メンテナンス性が高くてこそ、“良い開発ドキュメント”

スキル

» 2011/07/08

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

佐藤竜一（著）
翔泳社
2008年5月
ISBN-10: 4798117137
ISBN-13: 978-4798117133
2310円（税込）

　Wordはワードプロセッサです。

　Excelは表計算ソフトです。

　残念ながら、Excel方眼紙にドキュメント作成ツールとしての地位を奪われた感があるWordですが、きちんと機能を理解して使えば、必ずエンジニアの役に立つはずです。「Wordは変な動作をするし、おせっかいな機能が多くて使いにくい！」とは、言わせません。

■「より良いドキュメントを、効率よく作る」ための本

　「より良いドキュメントを、より効率良く、低コストで作成する」――これが本書の目指すゴールです。この目的を達成するために必要なWordの初期設定、および理解しておくべき機能などが解説されており、この点が一般的な入門書と違うところです。

　ざっと本書の各章を列挙してみましょう。

1章　ドキュメント作成の意味とは
2章　これだけはやっておきたいWordの初期設定
3章　スタイルを理解することから始めよう
4章　DRYで行こう！
5章　テンプレートを設計する
6章　図と表の取り扱い
7章　チームで作業を効率化する

　この目次を見るだけでも、ちょっと興味を引かれませんか？私は、目次にざっと目を通しただけで、なんだかうれしくなってしまいました。

■ドキュメントを作る時の「コスト意識」は重要

　まず、1章。この章で私が「なるほど」と思ったことの1つが、「ドキュメント作成に関するコスト意識」です。

　そもそも良いドキュメントとは何でしょうか。本書では、

読みやすく
体裁が整っていて
メンテナンス性が高い

ものであるとうたっています。この3原則の中では、「メンテナンス性」が最もダイレクトにコストに関連するのではないでしょうか。

　Excel方眼紙でドキュメントを作成すると、目次やドキュメントの折り返しなどはすべて手作業で行います。少しでもずれると、内容を削るか、全体をいじるか……この作業はかなりの労力＝見えないコストがかかります。

　1章で著者は、「Excel方眼紙はダメなのか。Wordを使用する方が良いのか」「良いドキュメントとは何か」「ドキュメントの質を見極めるポイントとは何か」について述べています。私は、ここだけでもコピーして社内で配りたくなりました（きっと、同じような人が続出すると思います）。

■Wordの“お節介機能”を取捨選択する

　2章では、著者が推奨する「Wordの初期設定」を紹介しています。いわゆる「各種お節介機能」の取捨選択です。「お節介！」と断じてしまう前に、有用な機能と、あまりそうでない機能は理解しておくべきです。

　2章のメインテーマは機能の解説とその有用性ですが、実は前から「Wordのこの機能って何なの？」と思っていて放置していた機能がたくさんあったので、とても勉強になりました。Wordは意外と奥深いソフトです。ものすごくしっかり考えられ、練られたソフトなんだなとつくづく感じます。

■メンテナンス性の高いドキュメントを作るための機能

　3章以降は、2つのテーマがあるように感じました。3章、4章、6章は、基本的なWordでのドキュメント作成に必要な機能の解説。5章と7章は、チーム内での共有や複数の人間がメンテナンスする際に役立つと思われる機能の解説だと解釈しました。5章は、両方の意味があると思います。

　この部分については、説明するより読んだ方が早いので、「まずは目を通して！」と言いたいところです。とはいえ、それでは書評にならないので少しだけ……。

　普段Wordを使っている時、「お節介な機能」「変な動作をする」と感じる状況があるかと思います。それらは、おそらく3章、6章あたりを読めばおおむね解決するでしょう。むしろ、これらの章に書かれていることを押さえないことには、どうにもなりません。個人的には、表や図の配置、回り込みの部分をあまり理解せず適当に使っていたので、非常に役に立ちました。ここらへんの部分は、「読みやすく、メンテナンス性の高いドキュメント」を作成するために理解すべき内容です。

　3章を理解すれば、字下げやインデントをスペースで調整したり、個条書きを中点でごまかしたりしなくてもよくなるはずです。また、ちまちまとフォントの色や大きさを手作業で設定した揚げ句に、体裁がバラバラな「残念ドキュメント」を作成する……なんてこともなくなるでしょう。

■ちょっとマニアックな機能解説もある

　4章で紹介されている機能は、普段はあまり使う機会がないけれど、実は使いこなせばすごく役に立つものです。例えば、フィールドの埋め込み、図表番号などの相互参照などです。私も、実際には使ったことがほとんどありません。本書の中では、わりとシステマティックな部分が、この4章かと思います。フィールドの埋め込み、図表番号などの相互参照といった機能は、ドキュメントの作成、編集時における「繰り返し作業」を減らし、作業の効率化に役立ちます。

　もう一歩進んで、本当に良いドキュメントを、チームの誰もがWordで作成できることを目指すなら、5章と7章が参考になるでしょう。5章ではテンプレート、7章は変更履歴やドキュメントのバージョン管理機能についての解説です。せっかくだから、このレベルまでWordを使いこなしてみたいと、切に思いました。