機能一覧と確認観点
各機能の役割と確認観点をまとめています。具体的な操作は画面仕様を参照してください。 番号は、この仕様書内で機能を参照するときに使います。
機能一覧
| No | 機能 | 利用者が行うこと | 画面 |
|---|---|---|---|
| 1 | タスク一覧 | 登録済みタスクを確認し、フィルタ・ソートする | タスク一覧 |
| 2 | タスク登録 | タイトル・担当者・期限・優先度を入力して保存する | タスク登録 |
| 3 | タスク編集 | 登録内容とステータスを変更する。不要なタスクを削除する | タスク編集 |
| 4 | 検索 | 条件に合うタスクを探す | タスク一覧 |
画面と公開APIの対応
| 操作 | この仕様書で記載する公開API | 記載状況 |
|---|---|---|
| 一覧を取得 | GET /api/v1/tasks |
一覧取得APIを記載 |
| タスクを登録 | POST /api/v1/tasks |
登録APIを記載 |
| タスクを更新・削除 | 未定義 | 画面操作のみ記載 |
| タイトル検索・ソート | クエリ未定義 | 画面仕様の一部のみ記載 |
この表は機能と公開APIの対応を示します。画面がこれらのAPIを内部で使うかは未定義です。
確認観点
| 機能 | 確認する操作・条件 | 期待する結果・確認先 |
|---|---|---|
| 一覧 | ステータス・担当者を指定 | 条件に合うタスクを表示 |
| 登録 | 必須項目を入力して登録 | 保存後に一覧へ戻る |
| 登録 | タイトルが100文字・101文字 | 上限は100文字。画面のエラー表示方法は要確認 |
| 登録 | 期限を入力しない | 期限は任意のため登録可能 |
| 登録 | 優先度を指定しない | 既定値「中」を使う |
| 編集 | 登録内容・ステータスを変更 | 更新操作で変更を保存。保存後の遷移先は要確認 |
| 削除 | 「削除」を選ぶ | 確認ダイアログを表示。確定・キャンセル後の動きは要確認 |
| 検索 | タイトルの一部分を入力 | 該当するタイトルのタスクを表示 |
非機能要件の例
非機能要件では、システムの性能や利用条件などを定めます。
| 観点 | 現在の記載 | 実装・テスト前の確認事項 |
|---|---|---|
| 件数 | 一覧は最大100件。超過時はページネーション | 初期表示件数、総件数の表示、最終ページの操作 |
| 性能 | 一覧取得APIは2秒以内を目安 | データ量、同時利用者数、計測環境、測定範囲 |
「2秒以内」は目安で、性能を実測した結果ではありません。 合否判定に使う前に測定条件を決めます。
要確認の仕様
| 論点 | 現状 | 決めること |
|---|---|---|
| 検索対象 | 元の機能一覧はタイトル・担当者の部分一致、画面仕様はタイトル部分一致と担当者フィルタ | 担当者名の部分一致検索も提供するか |
| ソート | 操作可能との記載がある | 対象項目、既定順、同じ値の場合の順序 |
| 認証・権限 | 公開APIのAPIキー方式のみ記載 | 画面ログイン、誰が閲覧・更新・削除できるか |
| 更新・削除API | 未定義 | 外部連携に必要か、必要ならリクエスト・レスポンス |
次は 画面遷移と入力項目 で、一覧から登録・編集までの操作を追います。