裏付けたい箇所を選ぶ
記事で言及する前に、自分のプロジェクトの公開READMEにあるインストールに関する記述を確認しているとします。正確な箇所と、その近くにある条件を探してください。リポジトリのタイトルやプロフィールの自己紹介は、その記述を含むファイルの代わりにはなりません。
作業はその文書に限定してください。プロジェクトを実行したり、個人の連絡先情報を調べたり、コントリビューターのアカウントを私人の身元の証拠として扱ったりする必要はありません。
変化するブランチ表示をバージョンリンクに置き換える
GitHubの説明によると、通常のファイル表示はふつうブランチの現在の先頭を示すため、コミットが届くにつれて内容が変わることがあります。ファイルを表示しているときにyキーを押すと、ブランチ名ではなく特定のコミットを使うパーマリンクにURLが変わります。出典
その操作のあとに実際に表示されたURLをコピーしてください。開き直して、同じファイルと同じ箇所が表示されることを確認します。コミット識別子をでっち上げたり、開いていない検索プレビューから引用を組み立てたりしないでください。
現在のブランチのアドレスも必要なら、別にメモを残します。バージョンリンクは「どの文言を確認したか」に答え、ブランチ表示はプロジェクトが今何を示しているかを確認するために使います。
別の読者に十分な文脈を記録する
| 項目 | 確認時に記録する内容 | 目的 |
|---|---|---|
| リポジトリとファイル | 実際のプロジェクトとファイルパス | 引用する文書を特定する |
| コミット識別子 | コピーしたパーマリンク内のバージョン | このスナップショットを後の編集と区別する |
| 根拠となる箇所 | 短い抜粋または忠実な要約 | 主張を確認した文言に限定する |
| 近くの条件 | バージョン、環境、機能の制限 | 条件を落とさないようにする |
| アクセス日 | ソースを開いた日時 | 確認した時点を公開履歴と分ける |
たとえば、エクスポート機能が実験的だと書かれたREADMEがあるとします。裏付けられる記述は「実験的」という表現を保ちます。安定したURLは、それを検証済みの保証として書き換える根拠にはなりません。この例は引用の実践を説明するものであり、実在のリポジトリについての報告ではありません。
古い記述が今も妥当か判断する
現在のブランチが異なる場合は、両方の観察を残してください。引用した以前のバージョンと、実際に開いた現在の文言です。同じ確認として説明し続けながら、古い引用を黙って置き換えないでください。
ファイルには計画、例、古くなった手順が含まれていることがあります。そうした記述はプロジェクトに帰属させ、実装を独自に検証したと主張しないでください。後でアクセスできなくなった場合は、その制約を記録します。バージョン識別子は、恒久的なホスティングや許可を約束するものではありません。
これは署名済みコミットのバッジとも別の話です。GitHub Verifiedバッジのガイドでは、その異なるシグナルを扱っています。公開文書をより広く総合する場合は、AIソースレビューのチェックリストを使い、重要な主張が依拠する正確なバージョンをそれぞれ保持してください。