仕様書のことについて質問なのですが、

仕様書が無い状態でコーディングを行い、ある程度プログラムが
完成した状態で「仕様書書いてってや〜」と言われました。

以下の条件の場合、どのような仕様書を書けば良いと思われますか?
・前提知識のないプログラマが見た際に同等の動きをするプログラムが組める仕様書。
・”仕様書が無い状態”というのは、コーディング前に簡単なブロック図などで
 口頭で説明を受けて不明点はその都度指示を仰いで作業してました。
 (よってプログラムの動作を示す資料などはほぼ皆無。全て頭の中^-^;)
・始めは「仕様書はコッチで作るから大丈夫」と言っておられたのですが
 「ゴメン、時間作れそうにないから仕様書作って」といわれました。

どなたかアドバイスと仕様書制作のためになるページを紹介願います。
仕様書というものを書いたことが無いので今現在非常に不安な気持ちで作成しております。

回答の条件
  • URL必須
  • 1人2回まで
  • 登録:2005/06/08 23:41:13
  • 終了:--

回答(7件)

id:matsu911 No.1

matsu911回答回数136ベストアンサー獲得回数02005/06/08 23:52:59

ポイント10pt

このIEEEのテンプレートにしたがって書けば、割と過不足なく書けるとおもいます。

まあ、要らない部分は端折ってもいいでしょう。

id:syuzabu

お〜・・・なんか難しい(^-^;)

参考にしてみます。

2005/06/09 00:03:38
id:albega No.2

albega回答回数69ベストアンサー獲得回数02005/06/08 23:53:36

ポイント15pt

http://www.hatena.ne.jp/1071021766

人力検索はてな - 駆け出しプログラマをやっております。プログラム仕様書の上手なまとめ方の載っているサイトがあれば教えてください。実例に沿って解説してある所が良いです。..

以前の質問「プログラム仕様書の上手なまとめ方の載っているサイトがあれば教えてください」の回答を参照されるのはどうでしょう?


プログラム作成を依頼するほうが要求仕様をまとめていない以上、作った方で作成できるのはプログラムの機能、パーフォーマンスを説明すること(プログラム作成のために説明を受けたことをまとめる)、および想定される範囲の例外処理を記述して仕様書をまとめるしか出来ないでしょう。

id:syuzabu

アドバイスありがとうございます。

う〜ん、難しいです。(^-^;)

紹介アドレスから私が欲しい情報は得られませんでした。(T-T)

2005/06/09 00:09:32
id:maybetrue No.3

maybetrue回答回数5ベストアンサー獲得回数02005/06/08 23:55:39

ポイント5pt

富士通のドキュメント標準がダウンロードできます。

id:thim No.4

thim回答回数35ベストアンサー獲得回数12005/06/09 00:04:24

ポイント25pt

プログラム仕様書を書けばいいわけですが、そのプログラムの

・入出力は何なのか(入力の前提条件と結果出力の条件は何なのか)

・どういう役割を負うのか(どこまでは責任を負うがそれ以降は別のプログラムに任せるなど)

・異常が起こった場合どう振舞うのか

の詳細が示されていれば良いと思います。

id:syuzabu

具体的なアドバイスありがとうございます。

入出力に関してはデータフローで出してました。

その発生条件てのはフローチャートとかで表すのでしょうか?

異常が起こった場合・・・例外処理とかも書くんですねぇ(当たり前か;;)

仕様書の構成も中々難しいです。

2005/06/09 00:21:17
id:fruitage No.5

fruitage回答回数77ベストアンサー獲得回数02005/06/09 00:24:15

ポイント15pt

なんとなく形式的に必要だから仕様書を書くだけのような気がします。

最低限の内容でも十分ではないでしょうか?


上記URLのDoxygenでも使って、概要だけでもプラスアルファしておけば満足される可能性大です。

id:syuzabu

うぉ、コレ凄いですね。w

うーん、でも求めてるものとは若干違うような気がします。

だけどありがとう。以後自分用資料作成として遣わさせて頂きます。

2005/06/09 00:55:52
id:KuroNeko666 No.6

黒猫回答回数144ベストアンサー獲得回数22005/06/09 00:34:00

ポイント20pt

URL is dummy.

とりあえず仕様書ではなく、いままで指示を受けたことを全て書き出してみてはいかがでしょうか?

目的と使用しているサーバ情報、環境要件、ソフトの連携、ソフトの動作などなど。

分かるだけの情報を全て書くのが詳細設計で、その概要みたいなのが仕様書だと思っていますが…(間違えていたら、いわしに書いていただけるとうれしいです^^;)

他に参考になるような仕様書があるはずなので、私なら指示を出した人に聞いてみます。

サンプルがあれば頂いてしまいます。

ある程度同じ作り方のほうが、顧客も見やすいですしね(^^)

それを体裁を整えてレビューをしてみて、ダメな点を言って貰うほうが、身につくと思います。

ベテランならともかく、書くのが初めてなら、普通に注意だけで終わるはずです。


経験則だけに、甘い部分があるとは思いますが、ご容赦くださいませ m(__)m

id:syuzabu

うーむ、やぱ今までのことを洗い出してからですね・・・

ただ時間が経ちすぎて頭の中が風化しそうな状態ですが;;

外注さんが作られた仕様書はあるのですが

ドライバ部の機能に対しての仕様なので

アプリケーション部を作っている私にはあんまり参考にならない・・・

というか仕様書の説明が必要最小限過ぎて

何をどう纏めているのか私には理解できない状態です。

とりあえず回答いくつか頂いたので参考にさせて頂きます。

・・・う〜、仕様書ってホントに難しいですねぇ。(T-T)

2005/06/09 01:14:06
id:KuroNeko666 No.7

黒猫回答回数144ベストアンサー獲得回数22005/06/09 01:03:03

ポイント10pt

URL is dummy.

とりあえず仕様書ではなく、いままで指示を受けたことを全て書き出してみてはいかがでしょうか?

目的と使用しているサーバ情報、環境要件、ソフトの連携、ソフトの動作などなど。

分かるだけの情報を全て書くのが詳細設計で、その概要みたいなのが仕様書だと思っていますが…(間違えていたら、いわしに書いていただけるとうれしいです^^;)

他に参考になるような仕様書があるはずなので、私なら指示を出した人に聞いてみます。

サンプルがあれば頂いてしまいます。

ある程度同じ作り方のほうが、労力も抑えられるし、顧客も見やすいですしね(^^)

それを体裁を整えてレビューをしてみて、ダメな点を言って貰うほうが、身につくと思います。

ベテランならともかく、書くのが初めてなら、普通に注意だけで終わるはずです。

今、私も宿題で人様が作成したシェルスクリプトの仕様書チェックをしております。

う~ん、穴だらけ…w

  • id:KuroNeko666
    重複投稿してしまってます(汗

    すいません、たぶん、最後の未開封は重複です…
    あけないで頂ければ幸せになれます
    本当に申し訳ありませんm(__)m
  • id:GIJYUTUSYA3
    http://www.hotdocument.net/
    で自動的に作るのはどうでしょうか。

    http://www.hotdocument.net/gallery/index.html
    こんな感じのが出ます。

    サンプルが、シリーズでそろっているようです。
    http://www.hotdocument.jp/
    http://document-csharp.com/
    http://document-cpp.com/
    http://document-java.com/
    http://document-vb.com/
    http://document-access.com/
    http://document-excel.com/

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません