根拠水準のマーク規約
本サイトの規程には、実証に基づかない値や単一の事例にしか支えられていない記述が含まれます。それ自体は避けられません。運用を開始しなければ実測が得られず、実測がなければ値を確定できないためです。
問題になるのは、それがどこにあるか分からなくなることです。本規約は、そうした記述をマークして追跡可能にする書式を定めます。
未完成の印ではありません
Section titled “未完成の印ではありません”ソースコードの TODO / FIXME は、書き手に向けた未完成の印です。
本規約のマークは違います。読者に向けた、根拠の水準の開示です。
| ソースコードの未完成の印 | 本規約のマーク | |
|---|---|---|
| 宛先 | 書き手 | 読者 |
| 意味 | まだ書いていない | 書いてあるが、根拠が弱い |
| 公開の可否 | 公開しない | 公開する |
トーン規約は未完成の痕跡を公開ドキュメントから排除します。本規約のマークはその対象外です。両者を混同しないでください。
| 記号 | 呼称 | 意味 | マーク |
|---|---|---|---|
| E0 | なし | 実証も一次事例もない。運用を開始するために置いた値・設計 | 必要 |
| E1 | 間接 | 隣接する領域の研究や実務報告はあるが、この文脈での測定はない | 必要 |
| E2 | 単一事例 | 一次事例または実証研究が1件。一般化可能性に限界がある | 必要 |
| E3 | 複数 | 独立した複数の測定が一致している | 不要 |
E3 だけがマークを要しません。「広く信じられている」はE0です。普及度は根拠ではありません。
:::caution[暫定 EV-0001 / 見直し 2027-02]**対象**: 連続失敗3回・無進捗2回という停止条件の初期値。**根拠の水準**: E0(なし)。**差し替え条件**: 3か月分の停止記録と、そこから算出した誤検知率。
実証に基づく値ではなく、記録を開始するために置いた値です。:::| 要素 | 規則 |
|---|---|
| 識別子 | EV- + 4桁の連番。再利用しない。マークを削除しても番号を空けたままにする |
| 見直し期限 | YYYY-MM。必ず定める。期限のないマークを認めない |
| 対象 | 何が暫定なのかを1行で。台帳の見出しになる |
| 根拠の水準 | E0(なし) E1(間接) E2(単一事例) のいずれか。呼称まで一致させる |
| 差し替え条件 | 何が得られたら確定させるか。「見直す」ではなく、判断に使う材料を体言止めで書く |
| 補足 | 任意。空行を挟んで記載する |
3つの項目は連続した行に置き、それぞれ句点で終えます。句読点の検査を通すためです。
差し替え条件を「継続して検討する」のような文で埋めないでください。条件を書けない場合、その記述はマークではなく削除の対象です。
npm run check が scripts/check-evidence.mjs を実行し、次を検査します。
- 書式の適合、必須項目の有無、識別子の重複
- 根拠水準の台帳が最新であること
台帳を更新するコマンドは次のとおりです。
node scripts/check-evidence.mjs --write期限の超過では npm run check を失敗させません。日付が過ぎただけでデプロイを止める構成は、期限そのものを名目化させます。期限の超過は月次の定期実行が検出し、棚卸しの Issue を起票します。
マークを外すとき
Section titled “マークを外すとき”根拠の水準が上がったときに外します。手順は次のとおりです。
- 差し替え条件の充足を示す資料(自組織の実測、または一次資料)を特定する
- 値または記述の変更を ADR として起票する
- ADR の採択後に、本文を更新してマークを削除する
マークだけを削除してはなりません。根拠が変わっていないのにマークが消えると、以後その記述は確定した規定として扱われます。
この規約の限界
Section titled “この規約の限界”マークの付け忘れを機械的に検出できません。検査できるのは、書かれたマークの書式だけです。根拠の弱い記述にマークが付いているかどうかは、人手のレビューで確認します。
この限界があるため、マークの網羅性を根拠に「マークのない記述はすべてE3である」と読んではなりません。