Skip to content

040-エラー処理

エラー発生時のユーザ表示メッセージやログ出力方針を記述します。

ドキュメントの目的

  • 業務システムのエラー処理仕様(表示メッセージ、ログ出力、通知、復旧手順等)を明確化し、設計・開発・運用の品質を高める。
  • エラー処理設計・運用・障害対応の根拠とする。

ドキュメントの内容

ドキュメントには、少なくとも以下を含めます。

  • エラー処理仕様一覧表(エラー種別、表示メッセージ、ログ出力、通知、復旧手順等)
  • サンプル(小売業務システム例)

なぜこのドキュメントが必要か

  • エラー処理仕様を明確にすることで、設計・開発・運用の品質と効率を高める。
  • エラー処理設計・運用・障害対応の認識ズレ・トラブルを防ぐ。

このドキュメントがないとどう困るか

  • エラー処理仕様が曖昧になり、設計・開発・運用で誤解や手戻りが発生する。
  • エラー処理設計・運用・障害対応の認識ズレによる品質低下・トラブルにつながる。

サンプル

エラー処理仕様(小売業務システム例/表形式)

エラー種別表示メッセージログ出力内容通知・復旧手順備考
入力値不正入力値が正しくありませんエラー内容・入力値画面で再入力促す項目ごとにバリデーション
DB接続失敗システムエラーが発生しましたエラー内容・タイムスタンプ管理者にメール通知自動再接続・リトライ
バッチ異常終了バッチ処理が失敗しましたエラー内容・ジョブID管理者に通知・再実行履歴に異常記録
権限不足権限がありませんユーザーID・操作内容画面で警告表示ログイン権限管理

注:上記は例です。実プロジェクトのエラー処理仕様を具体的に記載してください。