仕様書の書き方

システム開発

　結構「仕様書」で検索をかけてきてくださる方もおいでのようですので、私ことhaniel的仕様書の書き方おば論じてみたいと思います。何も先進的なことはないと思いますが。
　まず、「IEEEの仕様書の書き方」に従っていただければ良いんじゃないかなんて思っちゃいますが、それではあまりにも乱暴なので少し噛み砕いてみたいと思います。

表紙

　案外これをつけない人がいます。的確なタイトルをつけ（これが意外に難しい）、第何版なのかを明記し、だれのレビューを受けたのか（承認を受けたのか）を明記できるようにしておくといいでしょう。

目次

　これは絶対に必要です。どんな薄いものでも目次（当然ですがページ番号は正確に！）をつけましょう。

適用範囲

　この仕様書はいったい何のためにかかれたものかを明記します。これは読み手はもちろん、書くほうにとっても大事で、内容が変にぶれないようにする効果があります。例を示しますと

　このドキュメントは、○○○株式会社殿向けショッピングサイトシステムのユーザインタフェースの仕様について記したものである。

といったように書くと良いでしょう。

用語定義

　「名称」というのはものすごく大事です。ある物事を表わす言葉はプロジェクトにかかわる人全員において揺らぎがあってはなりません。また、「名称」がなく、形容詞的に表わす以外ない状態というのも問題です。それを打破するためにプロジェクトのごく初期に用語定義は行っておくべきです。システムを通した横断的な用語定義はひとつの文書として作成しても良いでしょう。

個々の要件定義

　仕様書というとこれだけを書く人が見かけられます。もちろん、これがあるからこそ仕様書なわけです。これの書き方はシステムによって違ってくるので一概に言えませんが、注意点を挙げるならば以下のようになります。

  • 図表番号やリスト番号、表番号を振りましょう。
  • 見出しやキーワードはゴシック体、その他は明朝体というように字体にメリハリをつけましょう。
  • 章立ては一貫させ、インデントは統一しましょう。編纂された論文集や百科事典が参考になるでしょう。

改定履歴

　改定履歴を先につけることもあるようですが、私は後につけることをお奨めします。なぜならば、改定回数が増えると1ページに収まらなくなったりするわけですが、改定履歴のためだけに全体のページ番号が変わってしまうのはもったいないと思うからです。
　改定履歴は、いつ何が変わったのかということを完結にまとめます。Wordで仕様書を書いているのでしたら、Wordの履歴機能とうまく併用するといいでしょう。

以上、簡単ですが参考にしていただければ幸いです。