仕様書のイベント-動作の表現方法

質問

外注さんにあるマイコンのソフトを作成してもらうために仕様書を書くことになりました。

各機能ごとに章立てして、その中に、
　(1)機能の概要
　(2)画面デザイン、
　(3)各イベントに対する動作など
を記述しているのですが、(3)についてどうもうまく整理された形で表現できません。

Wordを使用しているのですが、箇条書きにするとだらだら羅列してあるだけで、本当にそれで全てが網羅されているのかわからない、かといって、縦(イベント）×横(状態)の一覧表にすると、横(状態)が膨大な量になり収集がつかなくなってくる．．．
文や表でななく、フローチャートやPADで記述した方がいいのではとも思ったのですが、みなさんはどのように表現されていますか？
お知恵を貸して下さい。

回答No.1

whitepepper · ベストアンサー

たぶん、この仕様書がわかりやすく正確に書かれているなら、それに忠実に従って造られたソフトもわかりやすく正確なものになるでしょう。すなわち、ソフトの出来如何はこの仕様書にかかっていると言ってもいいのではないですか。

　私はWordがあまり好きではないけど、リンクを多用すると思います。
　たぶん、ソフトは階層構造だろうけど、図示して、一覧できるようにします。その図の各項目にリンクを貼り付けて、その説明書きにジャンプするようにしますね。全体構造と各部分説明を分離します。
　それで、リンクをどんどん増やしていきます。そうすれば、同様にできあがったソフトにおいても各機能がリンクでつながるわけで、使いやすいものになるのじゃないですか。単純な階層構造の欠点は、横のつながりがないことです。
　ということで、仕様書は印刷物では困りますね。リンク機能が活かせるものになると思います。

お礼

ご回答ありがとうございます。
最終的に印刷物としても残すことが習慣になっているのですが、やはりそれだけでは限界がありますね。

目的として、
・それでシステムの仕様が把握できる
・それでコーディングができる
ことがまずはあげられるのですが、
Wordによる仕様書自体を機能ごとにリンクで階層構造化するというのは大変参考になりました。
ただその機能の説明の中で、(3)のような説明をどのように表現したらいいのかが、まだイメージできていません。

whitepepperさんはWordが好きではないそうですが、何をお使いになっていますか？

回答No.3

whitepepper

》whitepepperさんはWordが好きではないそうですが、何をお使いになっていますか？

　Wordの良いところは、多くの人が使っているので、文書ファイルのやりとりが楽です。その他にこれといった良い点は見いだせません。

　それで、目的に合わせていろいろ使います。もちろん好きなソフト、よく使うソフトというのはあるけど、何でもかんでもそれを使うのは正しくありません。数え切れないほどソフトが造られているのがWindowsマシンです。使用目的に合わせてそれを選んで使うのが当たり前だと思います。

　こういう仕事に向いているのがアウトラインプロセッサーですね。フリーソフトでも良いのがたくさんあります。ただ、最終的にWordの文書にしなければならないのでしたら、チト不便かもしれません。中でも、リッチテキストフォーマットやHTMLで出力できるものもありますから、それをお使いになればいいでしょう。

　大事なことはツールではありません。あなたの頭の中でそのソフトの機能がきちんと整理されているかどうかです。

参考URL：

http://www.forest.impress.co.jp/library/storyeditor2.html

お礼

おっしゃるとおり、最終的な目的はツールではなく、自分の考える仕様を如何に正しく伝え、誤解なく理解してもらうことができるかということにあります。
ご紹介いただきましたツール、参考にしたいと思います。
ありがとうございました。

回答No.2

chachako

こんばんは。参考程度に聞いてください。

UMLという言語をご存知でしょうか？
たぶん近い将来ISO(国際標準化機構)に採用されることになるであろう、統一モデリング言語です。

UMLを利用することによって今まで各システムごとにばらばらだった設計書が、誰が作っても同じ、つまり標準化されるようになります(しかも全世界的に)。
しかもUMLの優秀なところは、システム構築側だけでなく、システムを使用するユーザー側にも同じ設計書で説明ができることです。
ダイアグラムで設計されていますので、設計者が見てもエンドユーザーが見ても視覚的にうったえるのですネ。

ご質問の内容であれば、UMLで言うところの「ステートチャート図」というのがあてはまるでしょう。
普通Visioを使ってダイアグラム(フローチャートですね)を描いて行きますが、Wordでもなんら問題はないと思います。

一度書店およびネットで参考程度にのぞいてみてはいかがでしょうか？
・設計・コーディング・プレゼン
が一度に出来る方法です。
(オブジェクト指向のシステムを構築するための言語ですが他のシステムにも利用できます)

ご参考まで。

お礼

UMLは以前少し勉強しかけたことがあるのですが、それだけで終わってしまいました。自分が携わっているシステムがCによる非オブジェクト指向のものであったため、UMLをどのように使っていけばよいか分からなかったためですが、もう一度見直してみようと思います。
ありがとうございました。