Day 82:要件定義
Day 81では、作るアプリの企画を考えました。Day 82では、その企画を「何を作るのか」「誰が使うのか」「何ができれば完成なのか」が分かる要件に整理します。
要件定義は、アプリの設計や実装を始める前に、必要な機能やデータ、利用上のルールをはっきりさせる作業です。ここではDay 81の例に合わせて、読書管理アプリの要件をまとめます。在庫管理・顧客管理・家計簿アプリを選んだ場合も、同じ手順で考えられます。
ステップ1:企画と要件を区別する
企画では、「どんな困りごとを解決したいか」を考えます。要件定義では、その目的を実現するために「アプリが何をできる必要があるか」を具体化します。
- 企画:読んだ本や読みたい本を忘れないようにしたいです
- 要件:本を登録でき、一覧で確認でき、読書状況や評価を記録できる必要があります
「使いやすくする」「便利にする」のような表現だけでは、完成したか判断できません。「タイトルと著者名で検索できる」のように、動作を確認できる言葉に置き換えましょう。
ステップ2:何を作るかを決める
まず、アプリの目的を短くまとめます。
読みたい本、読んでいる本、読み終えた本を記録し、状況や評価で整理できるアプリです。
次に、今回作る範囲を決めます。学習用の最初の版では、コンソールアプリとして本の記録を管理し、データをJSONファイルに保存することにします。
- 作るもの:本の情報と読書状況を管理するC#アプリ
- 利用方法:コンソール画面のメニューから操作します
- 保存方法:アプリを終了しても記録を残せるよう、JSONファイルに保存します
- 初版では扱わないもの:複数人での共有、インターネット連携、本の画像保存
対象外の機能を決めておくことも重要です。機能を足し続けると、中心となる機能が完成しないまま開発範囲が広がってしまうためです。
ステップ3:誰が使うかを決める
今回の利用者は、個人で本を記録したい人とします。
- 読んだ本や読みたい本を忘れたくない人
- 本を読書状況やカテゴリで整理したい人
- 読み終えた本に自分の評価を残したい人
初版では、ログイン機能や複数人での利用は対象外です。利用者を個人に限定すると、アカウント管理やユーザーごとのデータ分離を作らずに済み、基本機能に集中できます。
ステップ4:必要な機能を決める
必要な機能は、利用者がアプリで行う操作として書き出します。
| 機能 | 内容 |
|---|---|
| 本の登録 | タイトル、著者、カテゴリなどを登録します |
| 一覧表示 | 登録した本を一覧で確認します |
| 本の編集 | 登録した本の情報を変更します |
| 本の削除 | 不要になった本の記録を削除します |
| 読書状況の変更 | 未読・読書中・読了を設定します |
| 評価 | 1〜5の評価を記録します。評価しない状態も選べます |
| 検索 | タイトルまたは著者名で検索します |
| カテゴリ絞り込み | カテゴリを指定して本を絞り込みます |
| データ保存 | 本の情報をJSONファイルに保存し、次回起動時に読み込みます |
機能の名前だけではなく、条件や結果も決めておきます。たとえば、「検索する」だけではなく、「タイトルまたは著者名に検索語が含まれる本を表示する」と定義すると、実装後の動作確認がしやすくなります。
ステップ5:各機能のルールを決める
機能ごとに、入力・処理・結果を具体的にします。
- 本の登録:タイトルは必須です。空欄または空白だけの場合は登録しません
- 読書状況:「未読」「読書中」「読了」のいずれかを選びます
- 評価:評価する場合は1〜5の整数を入力します。未評価は設定なしとして扱います
- 検索:タイトルと著者名を対象に、入力した文字を含む本を探します
- カテゴリ:本の登録時にカテゴリを記録し、同じカテゴリの本を絞り込めるようにします
- 削除:対象の本をIDで指定し、削除前に確認します
- 保存:登録・編集・削除などの変更後に保存し、次回起動時に読み込みます
ここで決めたルールは、入力チェックやテストの基準になります。後からルールを変えることもできますが、変更した場合は関連する機能やテストも見直します。
ステップ6:必要なデータを決める
アプリが扱う情報を、項目ごとに整理します。
| 項目 | 型の例 | 必須か | ルール |
|---|---|---|---|
Id | int | 必須 | アプリが自動で割り当てます |
Title | string | 必須 | 空欄や空白だけの値は不可です |
Author | string | 任意 | 未入力の場合は空文字列にします |
Category | string | 任意 | 例:小説、技術書、歴史 |
Status | ReadingStatus | 必須 | 未読・読書中・読了のいずれかです |
Rating | int? | 任意 | 未評価は null、評価する場合は1〜5です |
Rating を int? にするのは、まだ評価していない状態を表すためです。int だけでは、「未評価」と「評価0」を区別しにくくなります。評価ルールを1〜5にするなら、入力時に範囲も確認します。
ステップ7:要件に合うモデルを用意する
データ項目が決まったら、C#のクラスとして表します。これは要件を実装に結びつける例です。
namespace ReadingApp.Models
{
// 本の読書状況を表します
public enum ReadingStatus
{
Unread, // 未読
Reading, // 読書中
Finished // 読了
}
// 本1冊分の情報を表します
public class BookItem
{
// 本を識別する番号です
public int Id { get; set; }
// タイトルは必須です
public string Title { get; set; } = "";
// 著者名は省略可能です
public string Author { get; set; } = "";
// カテゴリは省略可能です
public string Category { get; set; } = "";
// 登録時の読書状況は未読にします
public ReadingStatus Status { get; set; } = ReadingStatus.Unread;
// 評価は1〜5、未評価はnullで表します
public int? Rating { get; set; }
}
}C#要件とクラスは同じものではありません。要件は「何が必要か」を決めるもので、クラスはそれをC#で実現する方法の一つです。たとえば、カテゴリを後から複数付けたいと分かった場合は、string ではなく文字列の一覧にするなど、設計を変更できます。
ステップ8:完成条件を決める
「完成した」と判断できる条件を、操作と期待する結果の組み合わせで書きます。
| 操作 | 期待する結果 |
|---|---|
| 有効なタイトルで本を登録する | 本が登録され、一覧に表示されます |
| タイトルを空欄にして登録する | 登録されず、入力を促すメッセージが表示されます |
評価に 4 を入力する | 評価4として保存されます |
| 評価を入力しない | 未評価として保存されます |
評価に 0 や 6 を入力する | 受け付けず、正しい範囲を案内します |
| タイトルの一部で検索する | その文字を含む本が表示されます |
| 該当する本がない条件で検索する | 該当する本がないと表示されます |
| 本の情報を変更してアプリを再起動する | 変更後の情報が読み込まれます |
| 本を削除してアプリを再起動する | 削除した本が一覧に表示されません |
この表は、開発後のテストにそのまま使えます。「機能を作った」だけで終わらず、期待どおりに動くか確認するところまでを要件に含めましょう。
ステップ9:セキュリティとデータの扱いを考える
読書管理アプリでは、個人情報をほとんど扱わない設計にできます。学習段階では、架空の本の情報で動作確認しましょう。
- 保存ファイルにパスワードなどの秘密情報を入れません
- 保存場所を決め、どこにデータがあるか分かるようにします
- JSONファイルが壊れて読み込めない場合、空のデータで上書きして既存データを消さないようにします
- 登録・編集・削除後に、保存が成功したか利用者に分かるようにします
ステップ10:要件定義テンプレートを完成させる
次のテンプレートに、選んだアプリの内容を記入してください。
アプリ名:
1. 何を作るか
・目的:
・アプリの利用方法:
・保存方法:
2. 誰が使うか
・主な利用者:
・利用者の困りごと:
3. 必要な機能
・
・
・
4. 必要なデータ
・項目名:
・型:
・必須か:
・入力ルール:
5. 操作と期待する結果
・操作:
・期待する結果:
6. 今回は作らない機能
・
・
7. 完成条件
・
・
・
ほかのアプリを選んだ場合のデータ例
読書管理以外の案を選ぶ場合も、機能とデータを対応させます。
- 在庫管理アプリ:商品ID、商品名、在庫数、入庫数、出庫数などを検討します。出庫後の在庫が負にならないルールが重要です
- 顧客管理アプリ:顧客ID、氏名、連絡先などを検討します。必要な情報だけを扱い、学習時は架空のデータを使います
- 家計簿アプリ:記録ID、日付、収入または支出、金額、カテゴリ、メモなどを検討します。金額には小数を正確に扱える `decimal` が適しています
Day 82のゴール
- アプリの目的と利用者を説明できます
- 必要な機能と、その動作ルールを具体的に書けます
- アプリで保存するデータと入力条件を決められます
- 完成条件を、動作確認できる形で表せます
- 初版の対象外を決め、開発範囲を整理できます
まとめ
要件定義では、企画を実装可能な形に具体化します。読書管理アプリの例では、利用者、必要な機能、本のデータ項目、入力ルール、完成条件を整理しました。
- 目的を、アプリが実現する動作に置き換えます
- 機能ごとに入力条件や処理結果を決めます
- データ項目には型、必須かどうか、値のルールを付けます
- 完成条件をテストできる形で書きます
- 初版では作らない機能も決め、範囲を広げすぎないようにします
Day 82の成果物は、要件定義テンプレートを埋めたメモと、操作・期待結果の一覧です。この内容を次の設計や実装の確認基準として使えば、何を作るのか迷いにくくなります。
