1. 新規機能追加の設計書とは
新規の機能追加や画面追加など、システム改修時に設計書を作成することがあります。
この設計書は、プログラマーやテスターがシステムの機能や画面の仕様を理解するために必要なものです。
また、顧客との要件確認の際にも利用されます。
2. 要件定義を把握する
新規の機能や画面を追加する場合、まずは顧客との要件定義をしっかりと把握することが大切です。
顧客からどのような機能が必要なのか、どのような画面を作成すべきなのか、といったことを確認し、
それを基に設計書を作成していきます。
3. 設計書の構成
設計書は、現場によって異なる場合がありますので、あくまで一例として以下のような構成で作成することがあります。
- 機能概要
- 操作方法
- 画面遷移図
- 処理詳細
- データベース設計
※プロジェクトによっては異なる場合があります。
現場の手法に合わせて構成を変更することがありますので、
詳細はプロジェクトの要件や方針に従って確認することをお勧めします。
4. 設計書の書き方
以下では、各項目について具体的な書き方を説明します。
4.1 機能概要の記載
機能概要では、新規追加する機能の目的や概要、具体的な機能要件、対象となる利用者
、関連する機能や画面などを記載します。
この項目では、新規機能追加の背景や目的を明確にすることが大切です。
4.2 操作方法の記載
操作方法では、新規追加する機能の使い方、画面に表示される項目やボタンの名称や機能、
入力するデータや入力ルールなどを詳細に記載します。
この項目では、プログラマーやテスターが機能を実装するための詳細な手順を理解できるようにすることが大切です。
4.3 画面遷移図の作成
画面遷移図では、新規追加する画面がどのような画面で、どのような画面遷移をするかを示します。
この項目では、画面の構成や遷移先、遷移元、遷移方法を明確にすることが大切です。
4.4 処理詳細の記載
処理詳細では、新規追加する機能や画面がどのような処理を行うかを詳細に記載します。
具体的には、処理のフローチャートやシーケンス図のように図形を用いる手法や、プログラム言語のコードのようにテキストで手順を記述する手法があります。それぞれの手法において、各処理がどのように実行されるかを示します。
また、入力値や出力値、処理に必要なデータや条件なども記載し、プログラマーやテスターが機能を実装するための詳細な手順を理解できるようにします。
処理詳細の記載は、システムの動作を正確に把握するために非常に重要です。
4.5 データベースの設計
データベース設計では、新規追加する機能で使用するデータベースのテーブルやカラム、関連性などを詳細に記載します。
この項目では、プログラマーがデータベースを実装するための詳細な手順を理解できるようにすることが大切です。
5. 設計書のレビュー
設計書の完成後は、関係者によるレビューを行い、不備や漏れがないかを確認します。
レビューには、開発チームや顧客、品質管理部門などを参加させ、多角的な意見を反映させることが大切です。
6. コツや注意点
新規追加する機能や画面は、システムの他の機能や画面と連携して動作するため、設計書作成時には、既存のシステムの機能や画面との整合性を確認し、それに基づいて設計を進めることが大切です。また、設計書はプログラマーやテスターだけでなく、将来的にシステムを拡張・改修する際にも参考になるため、詳細かつ正確に作成することが大切です。