040-エラー処理
エラー発生時のユーザ表示メッセージやログ出力方針を記述します。
ドキュメントの目的
- 業務システムのエラー処理仕様(表示メッセージ、ログ出力、通知、復旧手順等)を明確化し、設計・開発・運用の品質を高める。
- エラー処理設計・運用・障害対応の根拠とする。
ドキュメントの内容
ドキュメントには、少なくとも以下を含めます。
- エラー処理仕様一覧表(エラー種別、表示メッセージ、ログ出力、通知、復旧手順等)
- サンプル(小売業務システム例)
なぜこのドキュメントが必要か
- エラー処理仕様を明確にすることで、設計・開発・運用の品質と効率を高める。
- エラー処理設計・運用・障害対応の認識ズレ・トラブルを防ぐ。
このドキュメントがないとどう困るか
- エラー処理仕様が曖昧になり、設計・開発・運用で誤解や手戻りが発生する。
- エラー処理設計・運用・障害対応の認識ズレによる品質低下・トラブルにつながる。
サンプル
エラー処理仕様(小売業務システム例/表形式)
| エラー種別 | 表示メッセージ | ログ出力内容 | 通知・復旧手順 | 備考 |
|---|---|---|---|---|
| 入力値不正 | 入力値が正しくありません | エラー内容・入力値 | 画面で再入力促す | 項目ごとにバリデーション |
| DB接続失敗 | システムエラーが発生しました | エラー内容・タイムスタンプ | 管理者にメール通知 | 自動再接続・リトライ |
| バッチ異常終了 | バッチ処理が失敗しました | エラー内容・ジョブID | 管理者に通知・再実行 | 履歴に異常記録 |
| 権限不足 | 権限がありません | ユーザーID・操作内容 | 画面で警告表示 | ログイン権限管理 |
注:上記は例です。実プロジェクトのエラー処理仕様を具体的に記載してください。