クラス設計書

質問

いつもお世話になっております。

クラス設計書を作成する事になりました。

今までMVCモデルどころかクラス設計書を書いた事がないので、
イメージが沸かず困ってます。
※会社のドキュメントは存在しない

Googleで調べてもサンプルが・・・

イメージとしては
★Top controller
top class 定義
名称　action　　　 属性 説明
Top index public トップ画面
input_data public データ登録画面
update_data public データ変更画面
delete_data public データ削除画面
info_data public データ参照画面

因みに詳細設計に組み込もうと思っています。

ご教授願えないでしょうか。

回答No.1

めとろいと（@naktak）

何を勘違いされているのか分かりませんが、クラスの設計書と
言えども、自身の責任範疇の内容を記述するだけなので、
普通の詳細設計書などと変わりありません。

画面で『hogeボタンを押した場合の処理』という詳細設計があるならば、
それがクラスでは『hogeアクションが実行された場合の処理』と
なるだけです。

むしろMVCは利用するフレームワークによってクセというか
お決まりごとがあるはずなので、それを理解していなければ
設計書は作成できません。

サーバ側はクラスかもしれませんが、書こうとしている設計書は
1機能の設計書ではありませんか？
それならば画面単位のようですから、画面とクラスが1:1になる
でしょう。（多分）
その場合、当然クライアント操作もあるし、サーバ動作もあります。
（プッシュ通信でもない限り、実行契機がなければサーバ通信は行わない為）
つまり、概要図としては三層となり、

クライアント　　　　|　サーバ　　　　｜　データベース
------------------------------------------------------
hoge処理　　　　　　｜　　　　　　　　｜　　テーブル1
　↓　　　　　　　　｜　　　　　　　　｜　　テーブル2
fuga処理-----→fugaA処理←-------
　　　　　　　　　　｜　　↓　　　　　｜
XXX画面へ←----fugaA'処理　　　｜
　　　　　　　　　　｜　　　　　　　　｜

みたいな書き方をするでしょうし、それに合わせてクライアント操作仕様、
サーバ操作仕様などと分かれ、お互いに設計したインターフェース(プログ
ラムのことではありません)を通じて通信できるような設計書を書けばいい
だけです。

加えて、UMLでシーケンス図を書く程度でしょうし、
その図の書き方も、一定の規則を設けて書くことになるでしょう。

どういうものを作るかは、品質担保を念頭に、会社のやり方や工数に応じて
検討すべき事項でしょう。