仕様書のサンプルってありませんか？

質問

こんにちわ。
私は今、社内でRDBMS+PHP＋Flashを使用したシステムを
構築しています。
部内用なので3人で作っています。
期限も短かったのでなにもドキュメントなしに作り始め
ました（これが問題なのはよくわかっています・・・）
で、本来なら逆なのですがこれからドキュメントを整備
していこうと思っています。しかし、私自身各種仕様書
というものを作ったことがありません。
また、会社自体コンピュータ関係ではありますが開発会社
ではないため社内にサンプルも見つけられず困っています。
そこで仕様書について書き方やサンプルなどが掲載されて
いる本やサイトがあれば教えてください。
自分で探した限りではいいものが見つかりませんでした。
当然社外秘でしょうし、書き方に決まりはないのでしょう
からサンプルでかまいません・・・。

また、こうしたwebを使用したシステムの場合の仕様書
はどこまで書くのでしょうか？（JAVAScriptとかは？）

回答No.1

murasaki_rocks · ベストアンサー

こんにちは。
仕様書が後付けというのはよくある話でして、
残念ですが私自身サンプルなどを掲載しているサイトは知りませんが、アドバイスを少し。

まず、仕様書と言っても色々ありますので、作成手順に沿って考えてみましょう。
データベースを使用する　->　ＤＢ設計書
ＧＵＩだ　　　　　　　　->　画面設計書
といった具合に挙げていきましょう。

作成する中身はＤＢ設計書ならデータ項目名、テーブル名など
を列挙していけばよいでしょう。形にはなります。
画面設計書なら画面のハードコピーを貼り付けたりすれば
結構豪華になります。

こんな感じに適当に作りあとは関連しそうな項目を肉付けしていきましょう。
例えばweb系なら対応するブラウザのバージョンを書いてみたり、
バリデーションについて書いてみたり、
おまけにユースケース図とかを書いてみたりして、それらしく仕上げましょう。

最後に大事なこと、このシステムをメンテする人に心の中で謝ったらさあ出来上がり。

初めてなんだからそんな大層なものを作ろうと考えずに、
いろんな人に意見を聞きながらがんばれば、そう悪いほうへはいかないですよ。
頑張ってください。