読み手が判断をたどるための五項目
- 問いと対象
- 何を確かめたかったか、対象にした資料や工程はどこまでかを最初に置きます。
- 前提と方法
- 使った版、設定、入力、実施した手順を必要な範囲で示します。確認できない情報は推定と区別します。
- 観察した結果
- 実際の出力や測定記録へ参照を付け、見つけた箇所を特定します。良い例だけでなく判断に影響した失敗も含めます。
- 考察と限界
- 結果から考えたことと、まだ確かめていない説明を分けます。条件が違う仕事への適用範囲を広げすぎません。
- 次の判断
- 採用、再試験、保留など、その記録を受けて何を決めたかと、残っている問いをまとめます。
文章の中で、事実と推測の置き場を分ける
| 文章の中で、事実と推測の置き場を分ける | 記録する文の役割 | 書き方の例 |
|---|---|---|
| 観察 | 実際に見たことを示す。 | 指定した資料の出典が、この出力には含まれていなかった。 |
| 仮説 | 原因の候補を示す。 | 入力の渡し方が影響した可能性がある。未検証として残す。 |
| 判断 | 確認した範囲で選んだ対応を示す。 | 入力の条件を見直した試験を追加する。 |
ノートから、元の材料へ戻れるか試す
- 参照先の版を揃える
「最新版」だけでなく、確認した時点のファイルや識別子へ結び付けます。修正後も過去の判断対象を辿れるようにします。
- 別の担当者に読んでもらう
必要な資料へ辿れるか、前提を補わないと読めない箇所がないかを確認します。読めたことを、試験が再現できたことと混同しません。
- 追記の理由を残す
結論が変わった場合は、前の説明を無言で消さず、追加の根拠と変更した判断を区別して残します。
公開用の説明と、内部の検証記録を分ける
外部へ共有するノートは、読み手が理解するために必要な根拠を示しつつ、未公開の資料、個人情報、利用条件のある素材が含まれていないかを確認します。内部資料をそのまま添付できるとは限りません。
共有できない資料を使った場合は、公開できる範囲の条件と限界を説明します。資料を開示できない部分を、第三者が検証済みであるかのように書き換えません。
記録を続けやすくする工夫
すべての作業を詳しく書く必要がありますか。
判断を理解するために必要な前提と、結果へ戻れる参照を優先します。詳細な実行記録がある場合は、本文をその複製で埋めずに対応を示します。
後から間違いが見つかったらどうしますか。
訂正箇所と理由、新たな根拠を追記します。影響する判断や参照先があれば一緒に確認し、旧版だけが使われ続けないよう案内します。