1. 要件定義書を参考にする
基本設計書作成の最初のステップは、要件定義書をしっかりと理解し、それを基に作業を進めることです。
要件定義書は、システムの全体像を把握するための重要な資料であり、これを基にして設計が行われます。
2. システムの構成や機能を図や表で表現する
基本設計書は、システムの全体像を視覚的に捉えやすい形で表現するために、図や表を活用します。
これにより、システムの構成や機能を直感的に理解でき、
また全体の流れや相互関係を明確にすることが可能となります。
3. 網羅的な仕様や制約の記述の重要性
あなたが理解しているからといって情報を省略することなく、全ての詳細を記述することが重要です。
例えば、ログイン機能の場合、「ユーザーがIDとパスワードを入力し、システムが認証する」という表現では不十分です。
どのような条件で認証が成功し、どのような場合に失敗するのか？
認証後の画面遷移は？など、全ての詳細を網羅的に記述することが求められます。
不十分な例：
1. ユーザーはIDとパスワードを入力する。
2. システムは入力情報をチェックする。
網羅的な記述例：
1. ユーザーはIDとパスワードを入力する。
2. システムは入力情報がすべて埋まっているかチェックする。
3. もし、すべての情報が埋まっていなければ、エラーメッセージを表示する。
4. 入力情報がすべて埋まっている場合、システムはIDとパスワードが登録情報と一致するかをチェックする。
5. IDとパスワードが登録情報と一致しない場合、エラーメッセージを表示する。
6. IDとパスワードが登録情報と一致する場合、ユーザーをログイン状態にし、トップページにリダイレクトする。
4. データの送受信における詳細を記述する
システム内でのデータの流れについて詳細に記述することで、システムの動きをより明確にします。
具体的には、データの送受信元と送受信先、データの形式、処理のタイミングなどを明記することが重要です。
5. レビューとフィードバックを行う
設計書が完成したら、チームメンバーや関係者によるレビューを行います。
このフェーズは設計の品質を確保し、間違いや見落としを早期に発見するために重要です。
6. まとめ
基本設計書の作成は、一見難しそうな作業かもしれません。
しかし、要件を理解し、システムの構成や機能を図や表で表現し、網羅的な仕様や制約を記述し、
データの送受信における詳細を明記することで、十分に作成できます。
また、レビューとフィードバックを行うことで、設計書の品質を更に高めることができます。
以上のポイントを押さえて、より良い基本設計書作成に取り組んでみてください。