ข้อมูลใดควรอยู่ใน Github README.md

คุณคาดหวังว่าจะเห็นข้อมูลใดใน GitHub README?

ทุกอย่างควรไปใน README หรือไม่ กล่าวคือ

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

หรือคุณเพียงแค่ใส่บางสิ่งลงใน README (บทนำ, การติดตั้ง, เวอร์ชั่น) และข้อมูลอื่น ๆ ที่ดีที่สุดใน Github wiki?

documentation github

ฉันจะใส่ข้อกำหนดสิทธิการใช้งานด้วย

— py_script

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

— Keith Thompson

คำถามนี้มีรายละเอียด / คำตอบที่ดีมากที่นี่: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

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

— ไบรอัน Oakley
แหล่งที่มา

+1 สั้น ๆ อย่าพูดว่า "README" แล้วใส่ขยะเข้าไปในนั้นโดยไม่จำเป็นต้องอ่าน

— Korey Hinton