第1章:一次情報の優先順位(公式/仕様/実装/ブログ)

この章で学ぶこと

  • 情報源を“優先順位”で扱う(公式→仕様→実装→二次情報)
  • 対象バージョンと適用範囲を確認する
  • 結論と根拠リンクをセットで残す

成果物(または判断基準)

  • 調査ログ(付録: 調査ログテンプレ
  • 一次情報へのリンク(公式ドキュメント/仕様/リリースノート等)

本文

一次情報は「正しい可能性が高い」だけでなく、「前提(適用範囲、対象バージョン)が明記されやすい」という利点がある。一方で、一次情報でも改訂遅れや記載漏れは起きるため、対象バージョンと実挙動(検証)で補強する。

一次情報/二次情報の定義

  • 一次情報: 公式ドキュメント、仕様(RFC/規格/契約)、実装(ソースコード/テスト)、リリースノート
  • 二次情報: ブログ/記事、SNS、Q&A(一次情報への導線として活用する)

優先順位の例

  • 公式ドキュメント(製品/OSSのdocs)
  • 仕様(RFC/規格/契約)
  • 実装(ソースコード/挙動)
  • Issue/Discussion(設計意図の補助)
  • ブログ/記事(補助)

手順(最小)

  1. 目的(何を決めるか)と対象バージョン/適用範囲を固定する
  2. 一次情報(公式/仕様/実装)から該当箇所を特定する
  3. 未確定点(推測/未検証)を残したまま結論に混ぜない
  4. 調査ログに「結論」「根拠(リンク/引用)」「未確定点」を分離して残す

注意点

  • 公式ドキュメントでも古い記述が残る。リリースノートや実装(Permalink)で差分を確認する
  • Issue/Discussion は有用だが、仕様そのものではない。採用する場合は採用理由と前提を残す
  • ブログ/記事は対象バージョンが不明確になりやすい。一次情報へ辿る導線として扱う

具体例(悪い例→良い例)

悪い例

結論: デフォルトタイムアウトは 30 秒
根拠: たまたま見つけたブログ(リンクのみ)

良い例

結論: デフォルトタイムアウトは 10 秒(設定で変更可能)
根拠: 公式ドキュメント(対象バージョン明記)
根拠: 実装コード(定数/デフォルト値の確認)
補足: 再現コードで 10 秒を観測し、条件(ネットワーク遅延)をメモした

チェックリスト

  • 一次情報(公式/仕様/実装)に当たっている
  • 対象バージョンが明記されている
  • 結論と根拠リンクがセットになっている
  • 未確定点(推測/未検証)が分離されている

まとめ

  • 一次情報(公式/仕様/実装)を優先し、二次情報は補助として扱う
  • 結論は「対象バージョン」「根拠リンク」「未確定点」とセットで残す

次章への接続