เครื่องมือสร้างบันทึกการอัปเดตฟรี

บันทึกการอัปเดตคืออะไร?

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

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

บันทึกการอัปเดตหรือบันทึกการเปลี่ยนแปลง (Changelog)?

ผู้คนมักใช้คำเหล่านี้ปนกัน นี่คือการแบ่งที่ชัดเจนและมีประโยชน์:

เครื่องมือนี้ยังทำงานเป็นเครื่องมือสร้างบันทึกการเปลี่ยนแปลงได้ด้วย: สร้างบันทึกสำหรับแต่ละเวอร์ชันแล้วเพิ่มไว้ที่ด้านบนของหน้าบันทึกการเปลี่ยนแปลงของคุณ

สิ่งที่ควรใส่ในบันทึกการอัปเดต

• ชื่อผลิตภัณฑ์และเวอร์ชัน: “บันทึกการอัปเดต Acme Analytics 3.2”
• สรุปหนึ่งบรรทัด: การเปลี่ยนแปลงหนึ่งหรือสองอย่างที่ผู้อ่านส่วนใหญ่สนใจ
• ของใหม่, การปรับปรุง, การแก้ไข: เรียงตามลำดับนี้ โดยละส่วนที่ไม่มีข้อมูลไว้
• หัวข้อที่เน้นประโยชน์: สิ่งที่ผู้ใช้ทำได้ตอนนี้ ไม่ใช่สิ่งที่โค้ดทำ
• การเปลี่ยนแปลงที่ส่งผลกระทบ (Breaking changes): สิ่งที่ต้องทำอย่างชัดเจนและระบุให้เห็นเด่นชัด
• ลิงก์: ไปยังบทความช่วยเหลือหรือวิดีโอสำหรับสิ่งที่ต้องการคำอธิบายเพิ่มเติม

ตัวอย่างบันทึกการอัปเดตสั้นๆ

คอมมิตสามรายการ ได้แก่ “feat: export reports to CSV”, “fix: dashboard timezone off by one hour” และ “chore: bump dependencies” อาจกลายเป็น:

Acme Analytics 3.2
ตอนนี้คุณสามารถนำรายงานไปใช้ที่ไหนก็ได้ และแดชบอร์ดแสดงเวลาที่ถูกต้องแล้ว

ของใหม่

• ส่งออก CSV: ดาวน์โหลดรายงานใดก็ได้เป็นไฟล์ CSV เพื่อเปิดใน Excel หรือ Google Sheets

การแก้ไข

• เวลาบนแดชบอร์ด: แผนภูมิใช้เขตเวลาของคุณได้อย่างถูกต้องแล้ว

การอัปเดต dependency ถูกตัดออกในเวอร์ชันสำหรับลูกค้า เพราะผู้ใช้จะไม่สังเกตเห็น แต่เวอร์ชันภายในจะยังคงเก็บไว้

วิธีเตรียมการเปลี่ยนแปลงสำหรับเครื่องมือสร้าง

คุณไม่จำเป็นต้องทำความสะอาดรายการก่อน แต่การมีนิสัยบางอย่างจะช่วยให้ได้บันทึกที่ดีขึ้น วางการเปลี่ยนแปลงบรรทัดละหนึ่งรายการ ไม่ว่าจะเป็นข้อความคอมมิต ชื่อตั๋วงาน หรือประโยคทั่วไป คงคำนำหน้าแบบมาตรฐานเช่น “feat:” และ “fix:” ไว้หากคุณใช้งาน เพราะจะช่วยจัดกลุ่มการเปลี่ยนแปลงเป็นของใหม่และแก้ไข เพิ่มบริบทเล็กน้อยให้กับรายการที่เข้าใจยาก เช่น “fix: export (CSV was empty for large reports)” กรอกชื่อผลิตภัณฑ์และเวอร์ชันเพื่อให้ชื่อเรื่องพร้อมเผยแพร่ จากนั้นเรียกใช้สองครั้งหากคุณต้องการทั้งสองเวอร์ชัน: ครั้งหนึ่งสำหรับลูกค้า และอีกครั้งสำหรับทีมภายใน

แนวทางปฏิบัติที่ดีที่สุดสำหรับบันทึกการอัปเดต

เขียนเพื่อคนที่ใช้ผลิตภัณฑ์

“รายงานโหลดเร็วขึ้น” ดีกว่า “เพิ่มประสิทธิภาพตัววางแผนคิวรี” ให้เรียกชื่อฟีเจอร์ตามที่ปรากฏในอินเทอร์เฟซ

นำด้วยสิ่งที่สำคัญที่สุด

นำการเปลี่ยนแปลงที่คนส่วนใหญ่จะสังเกตเห็นขึ้นก่อน การแก้ไขเล็กน้อยสามารถใส่ไว้บรรทัดละรายการที่ส่วนท้ายได้

แสดงฟีเจอร์ใหม่

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

เผยแพร่ตามกำหนดเวลาที่ผู้คนหาเจอ

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

ข้อผิดพลาดทั่วไปในบันทึกการอัปเดต

• การคัดลอกบันทึกคอมมิตมาวางทั้งดุ้น พร้อมเลขตั๋วงานและศัพท์เทคนิค
• การซ่อนการเปลี่ยนแปลงที่ส่งผลกระทบไว้กลางรายการ
• การระบุทุกการเปลี่ยนแปลงภายในลงในบันทึกสำหรับลูกค้า
• การสัญญาถึงวันที่หรือฟีเจอร์ที่ยังไม่มีในการปล่อยเวอร์ชันนั้น

เครื่องมือนี้จะรวมเฉพาะการเปลี่ยนแปลงจากรายการของคุณและจะไม่เพิ่มวันที่ที่คุณไม่ได้ระบุ แต่ควรตรวจสอบแต่ละรายการก่อนเผยแพร่