現在、C言語で開発をしている者です。
(それ以外の具体的な事は言えません。勘弁してぇ~ください。)
質問ですが、プログラム詳細設計書について知りたいです。皆さんがどのようなものを作成されているのか、興味があります。ウェブ検索したところ、詳細設計書についての記述は色々とあるようですが見本が見つけられません。目的は、あくまで参考レベルに考えています。
すみませんが、コーディングする時に必要となるプログラム詳細設計書の見本を探してください。
宜しくお願いします。
フローチャートが一般的ではないでしょうか。
http://ja.wikipedia.org/wiki/%E3%83%95%E3%83%AD%E3%83%BC%E3%83%8...
http://www.cs.takushoku-u.ac.jp/caed/kisosemi/k7/FlowChart.html#...
http://www.pro.or.jp/~fuji/mybooks/cdiag/cdiag.3.3.html
ただし、コーディングには、これ以外にデータ設計書が必要であることです。(データ構造)
詳細設計のステージで、上流のデータ設計が出来ていないと話になりません。
プログラムは自己完結するものは少なく、対外は外部データをアクセスします。なので、コーディングするときに必要なものは、
・処理の流れ
・入力データ
・出力データ
です。
優れたコーダは入力データ、出力データ、処理の目的を伝えるだけでコーディングできますが、それはコーダーが詳細設計を頭の中でやっているからで、詳細設計が必要ないわけではありません。
ちなみに、詳細設計書を残す理由として、
・問題があったときの原因分析(原因ステージ)
・流用・改造時の参考資料
としての役割も大きいので蛇足ですが付け加えました。
おおまかなフローチャートを まず書きます。
http://www2.ee.knct.ac.jp/el/E2/L210/algorism/flowchart1.html
あと、そのフローチャートに基づき、関数化を 行います。
http://www.edita.jp/tkagawa2/one/tkagawa26087224.html
こちらのWebAPI定義みたいな感じです。
引数とか戻り値とかなどを 記載すればいいでしょう。
で、その関数の詳細なフローチャートも作っておいたほうがいいでしょう。
または、フローチャートを 文章化したものでもいいと思います。
返信有難う御座います。
フローチャートは、使用するつもりはなかったのです。現状は、文章化したものと、図を挟んでいこうかと考えています。うーん、データフローで利用していこうかと思います。
関数仕様書については、あまり考えてなかったので
作成します。(任せようかと考えていたので・・。)
フローチャートが一般的ではないでしょうか。
http://ja.wikipedia.org/wiki/%E3%83%95%E3%83%AD%E3%83%BC%E3%83%8...
http://www.cs.takushoku-u.ac.jp/caed/kisosemi/k7/FlowChart.html#...
http://www.pro.or.jp/~fuji/mybooks/cdiag/cdiag.3.3.html
ただし、コーディングには、これ以外にデータ設計書が必要であることです。(データ構造)
詳細設計のステージで、上流のデータ設計が出来ていないと話になりません。
プログラムは自己完結するものは少なく、対外は外部データをアクセスします。なので、コーディングするときに必要なものは、
・処理の流れ
・入力データ
・出力データ
です。
優れたコーダは入力データ、出力データ、処理の目的を伝えるだけでコーディングできますが、それはコーダーが詳細設計を頭の中でやっているからで、詳細設計が必要ないわけではありません。
ちなみに、詳細設計書を残す理由として、
・問題があったときの原因分析(原因ステージ)
・流用・改造時の参考資料
としての役割も大きいので蛇足ですが付け加えました。
有難うございました。
SECにユーザー登録して以下をDL
https://sec.ipa.go.jp/member/download.php?filename=SEC-TN05-009....
ドキュメントテンプレートも入手可能
SESSAMI
話題沸騰ポット仕様書
http://www.sessame.jp/workinggroup/WorkingGroup2/POT_Spec_Agreem...
YARNE ソフトウェア研究所
http://www5f.biglobe.ne.jp/~hotta/furui/siyousho/032des.html
有難うございました。
細かな動作を規定する場合は
状態遷移図
http://ja.wikipedia.org/wiki/%E7%8A%B6%E6%85%8B%E9%81%B7%E7%A7%B...
シーケンスチャート
http://www.mars.dti.ne.jp/~torao/program/oo/ood.html
これと「やりとりするデータのフォーマット」を規定します。
状態遷移図でなく状態遷移表であればEXCELで書けると思います。
http://ja.wikipedia.org/wiki/%E7%8A%B6%E6%85%8B%E9%81%B7%E7%A7%B...
シーケンスチャートもEXCELでかけます。
C言語はオブジェクト指向言語ではありませんが、
仕様書を書くレベルであれば、UMLの状態遷移図(ステートチャート)やシーケンスチャートが使えると思います。
JUDE/Community(無料)などを使うと便利かも知れません。
有難うございました。