最終更新: 2026/06/22 18:56
ドキュメント運用 週次レビュー
docs 運用の品質指標を 週次 で観測・記録する正典。複数の ADR は「月次で集計・判定」と定めているが、今の高頻度フェーズ(数日で ADR が受理される)では月次だと溜まりすぎて追いつかない。そこで週次で前倒し観測し、問題を溜まる前に拾う。各週の記録は template.md を <YYYY-Www>.md(例 2026-W24.md)にコピーして本ディレクトリに蓄積する。
ADR の月次規定との関係: ADR-0138 §5.2 等は「月次で集計」と規定する。本枠組みは実態(高頻度フェーズ)に合わせ運用を週次へ前倒ししたもの。ADR が定める撤退条件などの正式判定は各 ADR 規定の判定節目(受理 +1〜3 ヶ月)で行い、週次の観測値をその根拠に使う。開発ペースが落ち着いたら頻度(週次/月次)を見直す。ADR 本体の頻度記述は将来の amendment 候補。
運用手順
毎週(週初 or 週末)、以下を回す。
template.mdをweekly_review/<YYYY-Www>.mdにコピーする。- 観測項目の各指標を集計する(今週分の差分 + 累計)。
- 正式判定節目に到達した項目は判定し、撤退条件に抵触したら当該 ADR の撤退手順へ。
- 重要な変化があればサマリーを 1 行 changelog に残す。
- 担当: ドキュメント運用(sub)。スクリプト集計や生成器に依存する項目(メタ完全性・幽霊エントリー)は main と分担。
- 頻度: 週次(今の高頻度フェーズ)。ペースが落ち着いたら頻度を見直す。
観測項目と判定節目
| 項目 | 出典 | 観測開始 | 正式判定節目 | 測るもの |
|---|---|---|---|---|
| What's New 誤除外 | ADR-0136 | 今週〜 | 2026-07-11 | [skip-news] 除外件数・誤除外報告件数 |
| 早わかり形骸化・書き直し | ADR-0138 §5.2 | 今週〜 | 2026-07-11 | 形骸化件数・人手書き直し件数・食い違い件数 |
| 上位 20 本 早わかり保有率 | ADR-0140 | backfill 着手後 | 2026-08-11 | 保有率・対応付けレビュー食い違い件数 |
| ADR メタ完全性 | ADR-0107 | adr-index 完成後 | 2026-09-02 | メタデータ欠落件数・索引カバレッジ |
| COVERAGE_GAPS 幽霊エントリー | ADR-0149 / ADR-0145 | 今週〜 | 月次節目 | 幽霊比率・件数ガード発火・鮮度チェック |
観測は受理直後(今週)から週次で積み上げる。正式判定節目に達するまでは「観測のみ(判定保留)」。週次で積み上げることで、判定節目には複数週分のデータが揃い、月次の一発判定より早く異常を拾える。
観測項目の詳細
1. What's New 誤除外(ADR-0136)
- 指標:
[skip-news]による除外コミット件数 / 誤除外(本来載せるべきページの除外)報告件数 - データソース:
scripts/generate-doc-news.mjsの除外ログ /git log([skip-news]マーカー) - KPI: 誤除外 0 件(正式判定は月次節目で 0 件/月・許容上限 1 件)。週次では新規誤除外の有無を確認
- 正式判定節目: 2026-07-11(実装完了 2026-06-11 + 1 ヶ月)
2. 早わかり形骸化・書き直し(ADR-0138 §5.2)
- 指標: 今週受理 ADR の「早わかり 7 箇条がすべて 20 字以下の体言止めのみ」件数(形骸化)/ 人手全面書き直し件数 / 早わかりと本文の食い違い件数
- データソース:
docs/adr/の今週受理 ADR 本文 - KPI: 人手全面書き直し率 50% 以下・形骸化 0 件目安
- 撤退条件: 書き直し件数(撤退条件 #1)/ 食い違い件数(撤退条件 #2)が ADR-0138 の閾値超過
- 正式判定節目: 2026-07-11(受理 2026-06-11 + 30 日・§1.5 判断期限と同期)
3. 上位 20 本 早わかり保有率(ADR-0140)
- 指標: 既存 ADR 上位 20 本の早わかり保有率 / 全体保有率 / バックフィルの対応付けレビュー食い違い件数
- データソース:
grepまたは adr-index - KPI: 上位 20 本保有率 100%
- 撤退条件: 対応付け食い違い 4 本以上(20%)で LLM 下書き方式を中止し人手起草へ
- 観測開始: バックフィル着手後(上位 20 本のバックフィルは ADR-0140 実装タスク = main 領分・未着手)
- 正式判定節目: 2026-08-11(受理 2026-06-11 + 2 ヶ月)
4. ADR メタ完全性(ADR-0107)
- 指標: Scope / Status / Mode 等のメタデータ欠落 ADR 件数 / 索引カバレッジ
- データソース: adr-index(生成器は In Progress)
- KPI: メタ欠落が閾値未満
- 観測開始: adr-index 生成器の完成後
- 正式判定節目: 2026-09-02(受理 + 3 ヶ月・再評価トリガー)
5. COVERAGE_GAPS 幽霊エントリー(ADR-0149 / ADR-0145・DOC-OPS-32)
- 指標: 消化済みなのに残る「幽霊エントリー」比率(消化済み残存率)/ 件数ガード発火 / 鮮度チェック最終成功
- データソース: ADR-0149 Phase 2 のガード(件数ガード・鮮度チェック・ソース別乖離検知・PR #1936/#1939/#1940)/
COVERAGE_GAPS.md - KPI: 件数ガード発火 0・鮮度チェックが定周期内・幽霊比率 20% 未満(超で ADR-0145 撤退条件)
- 観測開始: 今週〜(ガードは実装済)
- 正式判定節目: 月次節目(DOC-OPS-32 = 初月検収を兼ねる)
記録の作り方
- 各週:
template.mdをweekly_review/<YYYY-Www>.md(例2026-W24.md)にコピーし、今週分を観測・記入する。 - 記録ファイルは本ディレクトリに履歴として蓄積する。
関連
- 週次レビュー 記入テンプレート
- 変更履歴一覧
- handover 残タスク一覧 — 幽霊エントリー(項目 5)の対象
- ドキュメント運用バックログ:
docs/_internal/02_project/TODO_future.md§7(DOC-OPS-33 で本枠組みを起票) - 出典 ADR: 0136 / 0138 / 0140 / 0107 / 0149 / 0145