Route 477

■ [misc] 「やさしい仕様書」を書くために使えそうな3つのアイコン

• Joel on Software - やさしい機能仕様 - パート 4: ヒント

「Joel on Software」によれば、より良いソフトウェアの仕様書を書くためには 挿絵や空白をたくさん使わないといけないのだそうだ。 なぜなら、文字でびっしり埋まった仕様書なんて誰も読みたくないし、 読まれることのない仕様書を書いたって仕方がないからだ。

というわけで、僕も「やさしい機能仕様書」を書く方法について少し考えてみた。 今日紹介したいのは仕様書をオライリー風にするという方法だ。

Joelの仕様書には、開発者、テスター、営業など様々な立場の読者のために脚注が付いているらしい。

例：

ノート：松江市の西に位置する湖、宍道湖は「しんじこ」と読む。「ししどこ」ではない。

さてここで、ノートの横にiconspediaで拾ったペンの画像を表示してみる。 どうだろう、なんとなくオライリーっぽい感じがしないか？(笑)

ノート：具体例を見たい場合は、4873113482などを参照されたい。あとは489100455Xの「コーディング ホラー」アイコンなんかが僕の中に強烈な印象を残しているが、しかしオライリー刊じゃなかったな。

テクニカルノートには工具のアイコンを並べるとそれっぽい感じになる。

テクニカルノート：この画像はiconspediaからPNGをダウンロードし、背景を白で塗りつぶしたものだ。実際にドキュメントで使用する際は、画像の周りを黒線で囲むと良いと思われる。

あと、注意すべき内容や未解決事項には目立つアイコンを使うといい。

注意：この黄色いアイコンは商用利用不可である。仕事で使う場合はもっと別のアイコンを探した方がいいとおもうよ。

それでは、良い仕様書ライフを。