ไฟล์ readme คืออะไร?

ไฟล์ readme เป็นไฟล์ข้อความที่มักจะรวมอยู่ในซอฟต์แวร์ที่มีข้อมูลทั่วไปหรือคำแนะนำเกี่ยวกับซอฟต์แวร์ลักษณะเฉพาะของข้อมูลนี้แตกต่างกันอย่างมากจากไฟล์ไปยังไฟล์ไฟล์ readme อาจมีคำแนะนำการติดตั้งข้อมูลการใช้ซอฟต์แวร์ทั่วไปข้อกำหนดในการให้บริการและข้อมูลทางกฎหมายอื่น ๆ หรือข้อมูลอื่น ๆ ที่เกี่ยวข้องกับซอฟต์แวร์อย่างน้อยไฟล์ README ทั้งหมดรวมถึงชื่อและเวอร์ชันของซอฟต์แวร์ชื่อของ บริษัท หรือบุคคลที่พัฒนาซอฟต์แวร์และวันที่ตีพิมพ์ไม่มีสูตรทั่วไปสำหรับการเขียน readme อย่างไรก็ตามและในที่สุดเนื้อหาขึ้นอยู่กับการเปลี่ยนแปลงของนักพัฒนาซอฟต์แวร์ในหลายกรณีชื่อไฟล์ไฟล์ readme จะเป็นตัวพิมพ์ใหญ่และจะถูกเรียกว่า readme.txt หรือสิ่งที่คล้ายกันไดเรกทอรีของโปรแกรมบางตัวย้ายชื่อไฟล์ที่เป็นตัวพิมพ์ใหญ่ไปยังด้านบนของรายการไฟล์ใด ๆ ดังนั้นการใช้อักษรตัวพิมพ์ใหญ่จึงให้ความโดดเด่นของไฟล์ readme และกระตุ้นให้ผู้ใช้ซอฟต์แวร์อ่านไฟล์ก่อนใช้โปรแกรมไฟล์ readme บางไฟล์มีชื่อจริงอ่านฉันก่อนหรือสิ่งที่คล้ายกันเพื่อกระตุ้นให้ผู้อ่านดูเอกสารประกอบก่อนที่จะเรียกใช้ซอฟต์แวร์

ไฟล์ readme สามารถมีข้อมูลหลายประเภทที่มีความสำคัญแตกต่างกันไปนอกเหนือจากชื่อและเวอร์ชันไฟล์ซึ่งโดยทั่วไปแล้วไฟล์ readMe มักจะมีประวัติเวอร์ชันหรือ changelog ที่แสดงรายการการเปลี่ยนแปลงที่ทำกับซอฟต์แวร์เมื่อเวลาผ่านไปผู้อ่านอาจรวมถึงรายการปัญหาหรือข้อบกพร่องที่ทราบซึ่งมีผลต่อการใช้ซอฟต์แวร์บางอย่างรวมถึงข้อมูลที่จำเป็นน้อยกว่าเช่นการตอบรับหรือข้อความส่วนตัวจากทีมพัฒนาสำหรับโปรแกรมที่ง่ายโดยเฉพาะอย่างยิ่งไฟล์ readMe อาจทำหน้าที่เป็นคู่มือผู้ใช้ที่สั่งการหนึ่งในการใช้งานซอฟต์แวร์โดยรวม

ไฟล์ readMe ที่ซับซ้อนนั้นหายากมากเนื่องจากนักพัฒนามักต้องการจัดวางข้อมูลที่จำเป็นอย่างง่ายและลักษณะที่กระชับไฟล์ readme มักจะถูกนำเสนอในรูปแบบข้อความธรรมดาที่มีตัวอักษรมาตรฐานและไม่มีภาพเว้นแต่นักพัฒนาจะรู้สึกว่าจำเป็นต้องมีสิ่งที่ซับซ้อนมากขึ้นความเรียบง่ายนี้จะช่วยขจัดสิ่งรบกวนที่ไม่จำเป็นและทำให้ผู้อ่านมุ่งเน้นไปที่ข้อมูลบางครั้งไฟล์ readme จะถูกนำเสนอในคำถามที่พบบ่อยหรือรูปแบบคำถามที่พบบ่อยในรูปแบบดังกล่าวนักพัฒนาคาดการณ์คำถามที่พบบ่อยที่สุดที่ผู้คนอาจมีเกี่ยวกับซอฟต์แวร์และให้คำตอบที่ชัดเจนและง่ายๆแทนที่จะจัดวางข้อมูลทางเทคนิคทั้งหมดในบล็อกของข้อความที่ผู้คนอาจถูกอ่าน