##設計
要件定義書を作成中、または完成したのちとかに
設計書を作りますね。
フォーマットなどはシステムごとに決まってしまっていると思いますが
これがあるといいよね、最低限これがないとな
みたいなものは、フォーマットに合わなくてもチラって追記しちゃうべきです。
経験としてこれがあると助かる、といったものをまとめます。
##そもそも調査するときに設計書だけで完結したいのよ
このボタンおしたら値どうなるんだっけ って調べたいときどうしますか？
最もダメだけどやりがちな方法が以下です。
1.画面のボタンを見に行く
2.挙動だけ確認したいなら打鍵したりdevツールみたりで終わり
3.どのテーブル更新?とかを調べるため、ボタンの挙動のメソッドを確認する
4.使用メソッドの定義元に飛び、どのテーブル使うか、どのシステム連携するかを追ってメモ
5.網羅したとき、調査結果のドキュメントができあがる
これについて、設計書がこうだと、上記が全部いらなくなります。
1.画面設計書にボタン位置や項目定義、画面イメージがある
2.画面設計書の機能説明に、画面押下時の挙動の説明がある
3.画面設計書の機能説明に、登場テーブル(CRUDだとなおよい)と連携APIや向き先システムがある
4.画面設計書の機能説明に、登場テーブル(CRUDだとなおよい)と連携APIや向き先システムがある
5.そもそもそれが設計書です
また、そもそもこの辺が分かっていないと製造ができないはずなので
最初からこういった部分が分かりやすくまとまっているとよいですね。
##必要なもの一覧
画面の場合
・画面遷移図
・画面イメージ
・項目定義
・機能一覧
・機能説明-挙動
・機能説明-登場テーブル
・機能説明-登場テーブル-抽出条件
・機能説明-使用API-対向システム名とか
・機能説明-使用API-リクエストとレスポンス
バッチの場合
・フロー図
・各フローでの挙動（日本語でロジック）
・各フローでの登場テーブル
・各フローでの登場テーブル-抽出/参照条件
##プラスα
以下は、フォーマットになくてもちょいメモとして記載しちゃおうよ！ってくらいなもの。
怒られなければ書いておいたほうがいいと、個人的に思うので是非書いてみてね
・業務上でどんな目的で使われる機能なのか
・いつ何の要件で実装されたか（設計書の更新履歴とは別でちょいちょい書いてあると何かと役立つ）
・実装上、今後まずいぞってたぐいの注意点（上限オーバーしたらエラーになるなどが対策されていない点）
→JavaソースのアノテートコメントでいうXXXみたいな感じ