บันทึกการเผยแพร่จะอธิบายข้อมูลสำคัญเกี่ยวกับการแจกจ่ายผลิตภัณฑ์ฮาร์ดแวร์หรือซอฟต์แวร์^{[ 1 ]}บ่อยครั้งที่บันทึกการเผยแพร่จะมาพร้อมกับการอัปเดตผลิตภัณฑ์ที่เผยแพร่ไปก่อนหน้านี้และกำลังใช้งานอยู่ แต่ก็อาจมีให้สำหรับผลิตภัณฑ์ที่ยังอยู่ในระหว่างการพัฒนาหรือทดสอบ (เช่น เวอร์ชัน เบต้า ) ^{[ 2 ] [ 3 ]}โดยทั่วไปแล้วบันทึกการเผยแพร่จะถูกแชร์กับผู้ใช้ปลายทาง ลูกค้า และผู้รับบริการขององค์กร^{[ 4 ]}

ชื่ออื่นที่ใช้และข้อมูลที่เกี่ยวข้อง ได้แก่changelog [ ^{5 ] [ 6 ]}บันทึกการเผยแพร่ การเปลี่ยนแปลงซอฟต์แวร์ ประวัติการแก้ไข การอัปเดต หรือ^README [ ^{7 ] บ่อย}ครั้งที่บันทึกการเผยแพร่และ changelog จะถูกเผยแพร่แยกกันเพื่อให้สามารถแยกแยะจุดเด่นของฟีเจอร์ออกจากข้อบกพร่องคำขอเปลี่ยนแปลงและการปรับปรุงอื่นๆ ได้^{[ 8 ] [ 9 ]}บันทึกการเผยแพร่แตกต่างจากข้อตกลงใบอนุญาตผู้ใช้ปลายทางเนื่องจากบันทึกการเผยแพร่ไม่ (ไม่ควร) มีข้อกำหนดทางกฎหมายใดๆ ของผลิตภัณฑ์ซอฟต์แวร์หรือบริการ จุดเน้นควรอยู่ที่การเผยแพร่ซอฟต์แวร์เอง ไม่ใช่เงื่อนไขทางกฎหมายเป็นต้น^{[ 10 ]}

บันทึก การเผยแพร่ (Release notes) อาจถูกจัดเตรียมเป็นเอกสารประกอบการส่งมอบงานสำหรับการทดสอบระบบและการทดสอบการบูรณาการระบบรวมถึงสภาพแวดล้อมการจัดการอื่นๆ โดยเฉพาะอย่างยิ่งใน องค์กรด้าน เทคโนโลยีสารสนเทศบันทึกการเผยแพร่สามารถประกอบด้วยผลการทดสอบและข้อมูลเกี่ยวกับขั้นตอนการทดสอบข้อมูลประเภทนี้ช่วยให้ผู้ที่อ่านบันทึกการเผยแพร่มีความมั่นใจมากขึ้นในการแก้ไข/เปลี่ยนแปลงที่ดำเนินการ และยังช่วยให้ผู้ดำเนินการเปลี่ยนแปลงสามารถทำการทดสอบการยอมรับ เบื้องต้น ได้

บันทึกการเผยแพร่สามารถอธิบายวิธีการติดตั้งหรือสร้างซอฟต์แวร์ แทนที่จะเน้นคุณสมบัติใหม่หรือแก้ไขข้อบกพร่อง^{[ 11 ]}อีกคำหนึ่งที่มักใช้ในบริบทนี้คือข้อกำหนดของระบบ : ฮาร์ดแวร์และซอฟต์แวร์ที่จำเป็นสำหรับการติดตั้ง เรียกใช้ หรือสร้างซอฟต์แวร์

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

ส่วนหัว

ชื่อเอกสาร (เช่น บันทึกการเผยแพร่), ชื่อผลิตภัณฑ์, หมายเลขการเผยแพร่, วันที่เผยแพร่, วันที่บันทึก, เวอร์ชันบันทึก เป็นต้น

ภาพรวม

ภาพรวมโดยย่อของการเปลี่ยนแปลง และในกรณีที่ไม่มีเอกสารอื่นใด ก็จะรวมถึงตัวผลิตภัณฑ์ด้วย

วัตถุประสงค์

อธิบายวัตถุประสงค์ของเอกสารนี้

ปัญหา

รายชื่อสิ่งใหม่ในเวอร์ชันนี้ รวมถึงการแก้ไขข้อผิดพลาดและคุณสมบัติใหม่ ๆ

สรุปประเด็นปัญหา

คำอธิบายสั้นๆ เกี่ยวกับข้อบกพร่องหรือการปรับปรุงในเวอร์ชันที่เผยแพร่

ขั้นตอนในการจำลองปัญหา

ขั้นตอนที่ดำเนินการเมื่อพบข้อผิดพลาด

ปณิธาน

คำอธิบายโดยย่อเกี่ยวกับการปรับปรุง/แก้ไขที่ทำขึ้นเพื่อแก้ไขข้อผิดพลาด

ผลกระทบต่อผู้ใช้ปลายทาง

ผู้ใช้งานปลายทางต้องดำเนินการอย่างไรบ้าง รวมถึงตรวจสอบว่าการเปลี่ยนแปลงเหล่านี้ส่งผลกระทบต่อฟังก์ชันการทำงานอื่นๆ ด้วยหรือไม่

การสนับสนุนส่งผลกระทบ

จำเป็นต้องมีการเปลี่ยนแปลงในกระบวนการบริหารจัดการซอฟต์แวร์ในแต่ละวัน

หมายเหตุ

ข้อมูลอื่นๆ เช่นการติดตั้งการอัปเกรด และเอกสารประกอบผลิตภัณฑ์ (รวมถึงการอัปเดตเอกสาร)

ข้อสงวนสิทธิ์

ข้อความที่เกี่ยวข้องกับบริษัทและผลิตภัณฑ์มาตรฐาน (เช่น ประกาศ ต่อต้านการละเมิดลิขสิทธิ์คำแนะนำเกี่ยวกับซอฟต์แวร์ฟรีหรือข้อมูลอื่น ๆ เกี่ยวกับการทำสำเนา) โปรดดูคำชี้แจงข้อจำกัดความรับผิดชอบ ด้วย

ติดต่อ

ข้อมูลติดต่อฝ่ายสนับสนุน

ข้อกำหนดโครงร่างบันทึกการเผยแพร่เป็นข้อกำหนดที่เสนอสำหรับเอกสารบันทึกการเผยแพร่^{[ 12 ]}

• Laura Moreno และคณะARENA: แนวทางสำหรับการสร้างบันทึกการเผยแพร่โดยอัตโนมัติ IEEE Transactions on Software Engineering (เล่มที่: 43, ฉบับที่: 2, 1 กุมภาพันธ์ 2017) ^{[ 13 ]}
• นิวตัน, เคซีย์ (10 กุมภาพันธ์ 2016). "ฉันดื่มเบียร์และเขียนบันทึกการเผยแพร่ร่วมกับทีมเขียนบันทึกการเผยแพร่ของ Medium" . The Verge . Vox Media . สืบค้นเมื่อ5 เมษายน 2021 .
• มาตรฐานการเขียนโค้ด GNU - บันทึกการเปลี่ยนแปลงเวอร์ชัน 6.8

• วิธีการเขียนบันทึกการเผยแพร่
• ควรเขียน Release Note อย่างไร? (Stackoverflow)
• บันทึกการเปลี่ยนแปลงของแอป The Strange Art of Writing
• ศูนย์รวมบันทึกการเปลี่ยนแปลง (หรือhttps://www.release-notes.com ) เป็นโอเพนซอร์สบน GitHub
• ข้อกำหนดโครงสร้างข้อมูลบันทึกการเผยแพร่