選擇你需要佐證的段落
假設你在文章提及之前,正在核對自己專案公開 README 中的安裝說明。找出確切段落及其鄰近條件。儲存庫標題或個人檔案簡介不能取代包含該陳述的檔案。
把任務限制在文件本身。你不需要執行專案、檢視個人聯絡資訊,或把貢獻者帳號當成私人身分的證明。
以版本連結取代會變動的分支檢視
GitHub 說明,一般檔案檢視通常顯示分支目前的 head,因此內容會隨提交而改變。檢視檔案時按 y 會把網址改成使用特定提交而非分支名稱的永久連結。來源
複製該動作後實際顯示的網址。重新開啟並確認它顯示相同的檔案與段落。不要憑空編造提交識別碼,也不要根據你尚未開啟的搜尋預覽建構引用。
如果你也想保留目前分支網址,請另做筆記。版本連結回答「我檢視的是什麼措辭?」,而分支檢視讓你查看專案目前呈現的內容。
為其他讀者記錄足夠脈絡
| 欄位 | 從你的檢視記錄 | 用途 |
|---|---|---|
| 儲存庫與檔案 | 實際專案與檔案路徑 | 識別所引用的文件 |
| 提交識別碼 | 複製的永久連結中的版本 | 區分此快照與後續編輯 |
| 佐證段落 | 簡短摘錄或忠實摘要 | 把主張限於所檢視的措辭 |
| 鄰近條件 | 版本、環境或功能限制 | 避免漏掉限定條件 |
| 存取日期 | 你開啟來源的時間 | 把你的查閱時間與發布歷史分開 |
以一個示範性 README 為例,它說匯出功能是實驗性的,則有佐證的陳述會保留「實驗性」。穩定網址不能作為把它改寫成經測試保證的理由。此範例說明引用實務;它並非關於真實儲存庫的報告。
判斷舊陳述是否仍相關
如果目前分支不同,請保留兩項觀察:你引用的較早版本,以及你實際開啟的目前措辭。不要默默替換較舊的引用,卻繼續把它描述成同一次查閱。
檔案可能包含計畫、範例或過時指示。把那些陳述歸屬於專案,而不是聲稱你獨立測試了實作。如果之後存取失敗,記錄該限制;版本識別碼不是永久託管或權限的承諾。
這也與簽署提交徽章不同。GitHub 驗證徽章指南 討論的是另一種訊號。若要更廣泛地綜合公開文件,請使用 AI 來源審查清單,並保留每項重要主張所依據的確切版本。