เลือกข้อความที่คุณต้องการอ้างอิง
สมมติว่าคุณกำลังตรวจสอบข้อความเกี่ยวกับการติดตั้งใน README สาธารณะของโปรเจกต์ของคุณเอง ก่อนจะกล่าวถึงมันในบทความ ให้หาข้อความที่แน่ชัดและเงื่อนไขที่อยู่ใกล้เคียง ชื่อรีโปหรือประวัติโปรไฟล์ไม่สามารถใช้แทนไฟล์ที่มีข้อความนั้นได้
จำกัดงานไว้ที่เอกสารเท่านั้น คุณไม่จำเป็นต้องรันโปรเจกต์ ตรวจสอบข้อมูลติดต่อส่วนตัว หรือถือว่าบัญชีของผู้มีส่วนร่วมเป็นหลักฐานของตัวตนส่วนตัว
แทนที่มุมมองสาขาที่เปลี่ยนแปลงได้ด้วยลิงก์เวอร์ชัน
GitHub อธิบายว่าการดูไฟล์ตามปกติมักแสดงหัวสาขาปัจจุบัน เนื้อหาจึงอาจเปลี่ยนได้เมื่อมีคอมมิตใหม่เข้ามา ขณะที่กำลังดูไฟล์ การกด y จะเปลี่ยน URL เป็นลิงก์ถาวรที่อ้างอิงคอมมิตเฉพาะแทนชื่อสาขา แหล่งที่มา
คัดลอก URL ที่แสดงจริงหลังการกระทำนั้น เปิดใหม่และยืนยันว่าแสดงไฟล์และข้อความเดียวกัน อย่าสร้างตัวระบุคอมมิตขึ้นเอง หรือประกอบการอ้างอิงจากตัวอย่างผลการค้นหาที่ยังไม่ได้เปิด
เก็บบันทึกแยกต่างหากหากคุณต้องการที่อยู่ของสาขาปัจจุบันด้วย ลิงก์เวอร์ชันตอบคำถามว่า “ฉันตรวจสอบถ้อยคำใด” ขณะที่มุมมองสาขาช่วยให้คุณตรวจสอบว่าโปรเจกต์นำเสนออะไรในตอนนี้
บันทึกบริบทให้เพียงพอสำหรับผู้อ่านคนอื่น
| ฟิลด์ | บันทึกจากการตรวจสอบของคุณ | วัตถุประสงค์ |
|---|---|---|
| รีโปและไฟล์ | โปรเจกต์และพาธไฟล์จริง | ระบุเอกสารที่กำลังอ้างอิง |
| ตัวระบุคอมมิต | เวอร์ชันในลิงก์ถาวรที่คัดลอกมา | แยกสแนปช็อตนี้จากการแก้ไขในภายหลัง |
| ข้อความที่อ้างอิง | ข้อความสั้นหรือสรุปที่ตรงตามต้นฉบับ | จำกัดข้อกล่าวอ้างให้อยู่ในถ้อยคำที่ตรวจสอบ |
| เงื่อนไขใกล้เคียง | เวอร์ชัน สภาพแวดล้อม หรือข้อจำกัดของคุณสมบัติ | หลีกเลี่ยงการตัดเงื่อนไขกำกับออก |
| วันที่เข้าถึง | วันที่คุณเปิดแหล่งที่มา | แยกเวลาที่คุณตรวจสอบออกจากประวัติการเผยแพร่ |
สำหรับ README ตัวอย่างที่บอกว่าคุณสมบัติส่งออกเป็น experimental ข้อความที่สนับสนุนได้ยังคงคำว่า “experimental” ไว้ URL ที่ถาวรไม่ได้ทำให้เราเขียนใหม่เป็นคำรับประกันที่ผ่านการทดสอบแล้ว ตัวอย่างนี้อธิบายแนวปฏิบัติในการอ้างอิง ไม่ใช่รายงานเกี่ยวกับรีโปจริง
ตัดสินว่าข้อความเก่ายังเกี่ยวข้องหรือไม่
หากสาขาปัจจุบันแตกต่าง ให้เก็บข้อสังเกตทั้งสองไว้ ทั้งเวอร์ชันก่อนหน้าที่คุณอ้างอิงและถ้อยคำปัจจุบันที่คุณเปิดจริง อย่าแทนที่การอ้างอิงเก่าอย่างเงียบ ๆ แล้วยังคงอธิบายว่าเป็นการตรวจสอบเดียวกัน
ไฟล์อาจมีแผน ตัวอย่าง หรือคำแนะนำที่ล้าสมัย ให้ระบุข้อความเหล่านั้นว่าเป็นของโปรเจกต์ แทนที่จะอ้างว่าคุณทดสอบการนำไปใช้ด้วยตัวเอง หากภายหลังเข้าถึงไม่ได้ ให้บันทึกข้อจำกัดนั้นไว้ ตัวระบุเวอร์ชันไม่ใช่คำสัญญาว่าจะโฮสต์ถาวรหรือได้รับอนุญาต
นี่แยกจากป้ายคอมมิตที่ลงนามแล้วด้วย คู่มือป้าย Verified ของ GitHub พูดถึงสัญญาณที่แตกต่างกันนั้น สำหรับการสังเคราะห์เอกสารสาธารณะในวงกว้างขึ้น ให้ใช้ เช็กลิสต์ตรวจสอบแหล่งที่มาด้วย AI และเก็บเวอร์ชันที่แน่ชัดซึ่งข้อกล่าวอ้างสำคัญแต่ละข้ออ้างอิงไว้