何が起きたかを説明するログを書く
収録 2026-11-02
文脈があり、検索でき、なぜ今回失敗したかに答えるログ。
あるフローにログを追加します（以下）。1）必須フィールド（イベント・対象・結果・所要時間・相関 ID）；2）例を一行書き、各項目の必要性；3）機密を漏らす項目とマスキング；4）この一行で答えられる質問のリスト；5）ログレベルの誤りの影響。ログを増やしすぎない。
当サイトオリジナル
中国語の原文
使い方
好的日志是写给三个月后半夜排错的自己。
こう変えてみる
- コードを書く前に要件と制約を復唱させる。
- 全体書き換えではなく、最小の変更とロールバック方法を出させる。
得られる成果物
- そのまま使える最小変更（コピー可能なコード）
- 影響範囲：変更ファイルと追従が必要な呼び出し元
よくある失敗
- 一度に十ファイル変更させ、何が原因か分からなくなる。
- エラーだけ貼ってコードとバージョンを省くと、使えない修正が返る。
出力のチェック
- 変更は動いて戻せて、無関係なコードに手を入れていない。
- 境界条件（空・巨大・同時実行）が説明かテストで押さえられている。
使いどころと注意
- 向いている用途：要件と制約を復唱させてから、最小限の動く変更を出させる。
- 注意：エラーにはバージョンと最小再現を添える。無いと一見もっともらしいが合わない修正が返る。