คู่มือโครงการ

วิธีเลือกหัวข้อคลังโค้ด GitHub ให้ค้นพบโครงการได้ง่าย

หัวข้อคลังโค้ดช่วยบอกว่าโครงการเกี่ยวกับอะไรและเชื่อมโยงกับคลังโค้ดที่เกี่ยวข้อง เลือกคำที่ผู้ใช้เป้าหมายเข้าใจ แทนการเติมทุกช่องด้วยเรื่องยอดนิยมที่ไม่เกี่ยวกัน

ทีมบรรณาธิการ GitHubStart · อัปเดต

สร้างชุดหัวข้อที่สั้นและตรงจริง

เขียนงานหลัก ระบบนิเวศทางเทคนิค และรูปแบบของโครงการ จากนั้นเลือกหัวข้อที่มีการรองรับจริงในสิ่งที่พัฒนาแล้ว ตัวอย่างด้านล่างเหมาะกับเครื่องมือตรวจสอบ CSV แบบบรรทัดคำสั่งที่เขียนด้วย Python แต่เป็นเพียงตัวอย่างป้ายกำกับ ไม่ใช่คำรับประกันยอดเข้าชมจากการค้นหา

python
cli
csv
data-validation

เพิ่มหัวข้อแล้วตรวจสอบบริบท

แก้ไขข้อมูล About บนหน้าคลังโค้ด เพิ่ม Topics ที่เกี่ยวข้องแล้วบันทึก ปัจจุบัน GitHub อนุญาตสูงสุด 20 หัวข้อ หัวข้อละไม่เกิน 50 ตัวอักษร โดยใช้อักษรตัวพิมพ์เล็ก ตัวเลข และยัติภังค์ ขีดจำกัดนี้คือเพดาน ไม่ใช่เป้าหมายที่ต้องเติมให้ครบ

เปิดลิงก์หัวข้อที่เพิ่มแล้วดูโครงการรอบข้าง คนที่กำลังดูโครงการเหล่านั้นจะเข้าใจหรือไม่ว่าทำไมโครงการของคุณจึงอยู่ที่นี่ หากแท็กกล่าวถึงฟีเจอร์ที่ยังเป็นเพียงแผน ให้ลบจนกว่าจะมีฟีเจอร์จริง ทำให้บทนำ README และคำอธิบายคลังโค้ดสอดคล้องกับกรณีใช้งานจริงเดียวกัน

ทบทวนหัวข้อหลังการเปลี่ยนแปลงสำคัญ

จดบันทึกการทบทวนสั้น ๆ เมื่อโครงการเปลี่ยนทิศทาง ไลบรารีที่กลายเป็นแอปอิสระอาจต้องใช้คำด้านรูปแบบและระบบนิเวศในชุดที่ต่างออกไป เก็บหัวข้อที่ยังเหมาะสมไว้ แทนการเปลี่ยนทุกป้ายกำกับเมื่อมีกระแสใหม่

  • วัตถุประสงค์: วันนี้คลังโค้ดแก้ปัญหานี้ได้จริงหรือไม่?
  • ระบบนิเวศ: ภาษาหรือเฟรมเวิร์กนี้เป็นส่วนสำคัญของโครงการหรือไม่?
  • รูปแบบ: เป็น CLI ไลบรารี เว็บแอป หรือชุดข้อมูล?
  • หลักฐาน: ผู้เข้าชมพบกรณีใช้งานที่กล่าวอ้างใน README หรือตัวอย่างได้หรือไม่?

คำถามที่พบบ่อย

หัวข้อคลังโค้ดรับประกันว่าจะได้ GitHub Star มากขึ้นหรือไม่?

ไม่ หัวข้อช่วยจัดหมวดหมู่และเพิ่มช่องทางให้คนค้นพบ แต่ผู้เข้าชมยังเป็นผู้ตัดสินว่าโครงการมีประโยชน์หรือไม่

ควรใช้หัวข้อให้ครบทั้ง 20 ช่องหรือไม่?

ใช้ครบเมื่อทั้ง 20 หัวข้ออธิบายโครงการได้ตรงจริงเท่านั้น ชุดที่สั้นและชัดเจนดีกว่าป้ายกำกับที่ไม่เกี่ยวข้อง

หัวข้อเหมือนคีย์เวิร์ด SEO ของเว็บไซต์หรือไม่?

ไม่ หัวข้อ GitHub จัดหมวดหมู่คลังโค้ดภายใน GitHub ส่วนหน้าเว็บไซต์ยังต้องมีเนื้อหาที่มีประโยชน์ ชื่อที่ชัดเจน และลิงก์ที่ระบบค้นหาเก็บข้อมูลได้ตามเจตนาการค้นหาของตนเอง

เอกสารอ้างอิง