理系のための文書作成術(2) ―― 図表を表現手段として活用する

　この連載では，ソフトウェア開発を例に，「どんな文書が開発を妨げるのか」，「分かりやすい開発文書を書くにはどうしたらよいのか」，「文書作成をどのように開発業務に組み入れていけば，品質と生産性が上がるのか」について考察する．今回は，「分かりやすい開発文書を書くにはどうしたらよいのか」に関して，特に図表の書き方に焦点を当ててみる．（編集部）

技術解説連載「理系のための文書作成術」 記事一覧
第1回　開発文書を分かりやすく記述する
第2回　図表を表現手段として活用する
第3回　開発文書の書き方はしごとのやり方を示す
第4回　自分の「赤ペン先生」を持とう
第5回　設計レビューでするべきこと，してはいけないこと
第6回　仕事で文書を「書かされている」あなたへのメッセージ

●お知らせ
　連載「理系のための文書作成術」が電子書籍になりました！
　ご購入は「Tech Village 書庫＆販売」のページから．

　仕様書や設計書など，開発文書の作成には図や表がしばしば使われます．図や表は，仕様定義や設計の結果を表現するための有効な手段です．特に，ソフトウェア開発では，プログラムの動きが目に見えにくいものです．その見えにくいソフトウェアの構造やアルゴリズムなどを視覚的に表現する方法として，図や表を多く用います．

　前稿で述べた「分かりやすい記述」のための要素は，そのまま図表の記述にも当てはまります．

正確であること ― 図表の表記ルールに則っている，表現に間違いがない，伝える事柄に間違いがない，一意に理解できる，など．

読みやすいこと ― 明快である，簡潔である，など．

目的に合っていること ― 図表の目的が明確である，目的に対して必要十分な事柄が記述されている，など．

　今回は，図や表の記述の仕方として，上記の下線部分を実践するためのヒントを紹介します．

　まずは，文書内で図や表の表現を利用する際に，原則として守るべき基本ルールを確認しておきましょう．ここで紹介するルールは，一般的なものですから，それぞれの文書作成の場において，異なる取り決めをしていることもあるでしょう．例えば，記述の内容を読み手に伝えるための特別な戦術として，あえて基本ルールとは異なる記述の仕方をする場合も考えられます．

[図表の基本ルール]
1．タイトルを付ける
2．図のタイトルは図の下，表のタイトルは表の上に書く
3．タイトルと内容を一致させる
4．同種の図表では形式を統一する
5．図には凡例を入れる
6．表は最左列を軸とする
7．表には空欄を作らない

　以下，一つずつ解説します．

1．タイトルを付ける
　図や表にはタイトルを付けましょう．タイトルとは，「図1　○○」　のような図や表の見出しのことです．キャプション(caption)と呼ぶこともあります．タイトルには，図表の番号と簡潔な説明を記載します．
一つの文書中に図表を複数入れる場合，図表には必ず番号を振りましょう．その上で，本文中から図表を指し示すには，図表番号を使います．図表番号を使わない「次の図では」や「上表（あるいは下表）によると」のような記述は，文書の改訂などの際に図表の位置が変わるとどの図表を指しているのか分からなくなってしまうので，避けましょう．図表番号は1文書内で，図1, 図2のように通し番号にすることもあれば，図1-1，図1-2のように，章などのあるまとまりを示す番号と，まとまりの中で識別するための番号の対で付番することもあります．いずれにしても，一つの文書内では，付番の仕方を統一しましょう．さらに，チームで取り扱う文書をメンバで共有するためには，取り扱う複数の文書内でも図表の付番ルールを定めることをお勧めします．

2．図のタイトルは図の下，表のタイトルは表の上に書く
　図1を見てください．原則では，図のタイトルは図の下に付け，表のタイトルは表の上に付けます．これは，JIS X 4051 （日本語文書の組版方法）で規定されています．

3．タイトルと内容を一致させる
　図や表の内容を表すタイトルにしましょう．また，タイトルに適合する図や表を書きましょう．例えば，図2を見てください．ここに示した図は，「プログラムの位置付け」というタイトルに対して，プログラムの位置付けが的確に分かる図になっていません．

4．同種の図表では形式を統一する
　同じような事柄が複数存在し，それぞれを複数の図や表で表す場合には，表記の形式を統一しましょう．図3に示した二つの表は，それぞれAAA機能とBBB機能のコマンドの一覧を示す表です．同じような事柄を表現するのに，二つの表では，表の罫線やフォント，列の見出し，記載する内容などの形式が異なっています．これらの表記を統一するだけで，表がぐっと見やすくなります．