ソフトウェアの仕様書作成について（C言語）

質問

「電車の時刻表を画面に表示するプログラムについて、詳細仕様を検討して作成しなさい。要求は、ユーザが、現在時刻と到着したい希望時刻を入力すると、今から乗れそうな列車の候補をいくつか提示して欲しいということだけである。
この要求に沿って仕様を詳細に検討しなさい。」

という仕様書作成の問題なのですが、よくわかりません。
とりあえず自分なりにがんばってみたのですが（後述）、どうも不自然さがあふれてて困っています。
どこを直して行けばよいでしょうか？

<************ここから*****************>
関数の形式：int train_time(int present_h, int present_m, int arrival_h, int arrival_m, const int time_table[][])
関数の目的：
時刻表の電車の時間、分をそれぞれtime_table[i][0], time_table[i][1]に読み込み、（iは電車を区別する番号で整数である。）
現在の時間と分をそれぞれpresent_h, present_mから受け取り、また、到着したい希望時間と分をそれぞれarrival_h, arrival_mから受け取る。
時刻表の時刻と比較し、現在時刻以降に発車し、到着時刻以前に到着するすべての電車の発車時刻と到着時刻を表示する。

入力の形式：present_h, arrival_h, time_table[i][0]は、0以上24以下の時間を表す整数
　present_m, arrival_m, time_table[i][1]は0以上60以下の分を表す整数
出力の形式：
　-1、0以上の整数

説明：
　時刻は24時間表記とする。
　秒単位は考慮しない。
例外時の処理：
　時刻で無いものを受け取った場合、例えば24以上の時間、60以上の分、文字列を受け取った場合などは-1を返す。
　NULLを受け取った場合-1を返す

回答No.2

dummyplug · ベストアンサー

仕様の記述はよくがんばっていると思います。
質問に書かれている仕様の範囲で気になるところと言えば、例えば
・「0以上24以下」というのは0も24も含むので例外時の処理に書いてある「24以上の時間」と矛盾する。23以下、24未満とするべき。また、型として（unsigned intでなく）intを選んでいるので負の値についても取り扱いを記述すべき。
・文字列やNULLを受け取れる引数はないように見えるが、例外時の処理についてそれらの記述があるのが不思議。そういうケースがないのなら混乱の元になるので記述すべきでない。
・time_table[＜列車番号＞][＜0:時、1:分＞]なのだと思うが、これだけだとこのテーブルに載っている時刻は「発車時刻」なのか「到着時刻」なのかわからない。わからないので「現在時刻以降に発車し、到着時刻以前に到着する」の判断の仕方もわからない。
・該当する列車の時刻表示の表示形式がわからない。実装者の一存で構わないのか。
・出力の値として-1を返すケース（の一部）は例外時処理として書かれているが、0以上の値はどういうときに返せばいいのか、0以外のことがあるのか、などが出力の規則がわからない。
というあたりが致命的に不足していると思いました。その他細かいところだと
・present_h, present_mなどと変数を分ける代わりに、struct { int h; int m; } time_s;のような構造体を定義しておき、struct time_s present;とする方が見通しがよくなる。
とかあります。

（余談）…ところで、個人的にはこの設問があまりよくないと思いました。前後の文脈でわかるのかもしれないので断定はできませんが、どこからどこまでの仕様をどのレベルで書けばよいのかがわかりません。私なら出題者にくってかかるかも。

詳細、という言葉だけからするとこうした関数レベルやその中身のアルゴリズムなどを記述すべきなようにも思えますし、それならばこんな漠然とした要求だけではなくて概要仕様のようなものが提示されてしかるべきだと思います。とすると、この漠然とした要求からプログラム概要の仕様をなるべく細かく考えろという設問にもとれます。

後者の意味の設問だとするならば、C言語がどうとかではなくて言語によらずプログラム全体の仕様を入出力のインタフェースを中心に記述するのがよいと思いました。

ユーザのUIはGUIなのかCUIなのかコマンドライン引数なのか、時刻は文字列で入力するのか数値か、時刻表データはファイルかデータベースか、書式はどうなっているか、出力形式はどういうフォーマットか、「いくつか」表示するとはいくつにするのか固定数か選択できるようにするのか、該当する列車が見つからないときにはどうするのか、入力の誤り（到着時刻の方が出発時刻より早い場合など）はどうするのか、などです。
それらから、データ構造をどうするか、プログラム全体の構造（処理の流れ）はどうするか、などと考えていって、機能分割やインタフェース定義から関数仕様へと落とし込み、最終的には引数やアルゴリズムなどの記述へと至ります。（やり方の一例ですが。）

あんな設問ちょっとでこれを全部かけ、と言われたらちょっと嫌ですよね。
仕事ならやりますけど、課題としてはどうかなぁという感じです。

ちなみに、仕事なら時刻表データのメンテナンスはどうするとか、こんなUIになるが大丈夫かというのをクライアントと確認したり、スケジュールはどうだとか、仕様に関連した色々な話に広がったりします。さすがにそんな設問ではあり得ませんけど参考まで。

お礼

厳しくかつ丁寧に指摘・説明していただいてありがとうございました。大変感謝しております。
仕様書って作るのは思ってたよりも難しいですね。社会人として出て行くまでにできるだけ力をつけてけるようにがんばります。

回答No.1

ChateauAres

フリーのプログラマーです。
自分が仕様書を受け取ったプログラマーになったつもりで第三者的に（客観的に）チェックするようにしています。

自分がこの仕様書を受け取ったつもりで気づいた点を書いてみます。

・関数の処理内容も記述したほうがよい。つまり「今から乗れそうな列車の候補」をどのようなロジックで解決するか、についてです。

・最終的な出力内容「今から乗れそうな列車の候補」がどのように出力されるか不明。printfでだらだら出るのか、別のファイルorデータベースに格納されるか分かりません。

・エラーコードはエラー種別に応じて変えたほうがよい

・入出力の例などを書くとよい。（文章力をカバーできる！）

・1時60分という入力はＯＫなのかな？とか日替わり（翌日にまたがった答え）を考慮するの？

言いたい放題言わせてもらいましたが、これだけ書ければ戦力にはなるかなと正直思いました。

お礼

解答ありがとうございます。
仕様書というのはプログラマーの方が迷わないようにしなければならない、ということですが、ずいぶん迷わせてしまったようで、まだまだ改変すべきところがあるみたいですね。
これを参考に自分でも考えてがんばってみたいと思います。