社内ツールの失敗メッセージを書く
収録 2026-11-06
社内ツールのエラーは、同僚がまず自分で一歩試せる必要がある。
社内ツールの失敗場面です：[用途、利用者、よくある失敗]。メッセージを書いてください：1）各メッセージに「何が起きたか・想定原因・次の行動」を；2）利用者が直せるものと保守担当に渡すものを分ける；3）コピーできる診断コマンドやログの場所を添える；4）通知ではなく再試行や自動修復にすべき失敗を指摘する；5）長さの上限と、利用者を責めない口調；6）平易な言葉に置き換える社内用語。
当サイトオリジナル
中国語の原文
置き換えるプレースホルダー 1
括弧の中をご自身の情報に置き換えてから送ってください。
[用途、利用者、よくある失敗]
使い方
利用者は二行しか読まない前提で書く。
こう変えてみる
- コードを書く前に要件と制約を復唱させる。
- 全体書き換えではなく、最小の変更とロールバック方法を出させる。
得られる成果物
- そのまま使える最小変更（コピー可能なコード）
- 影響範囲：変更ファイルと追従が必要な呼び出し元
よくある失敗
- 一度に十ファイル変更させ、何が原因か分からなくなる。
- エラーだけ貼ってコードとバージョンを省くと、使えない修正が返る。
出力のチェック
- 変更は動いて戻せて、無関係なコードに手を入れていない。
- 境界条件（空・巨大・同時実行）が説明かテストで押さえられている。
使いどころと注意
- 向いている用途：要件と制約を復唱させてから、最小限の動く変更を出させる。
- 注意：エラーにはバージョンと最小再現を添える。無いと一見もっともらしいが合わない修正が返る。