แนวปฏิบัติที่ดีในการเขียนบันทึกประจำรุ่น

ในการส่งมอบซอฟต์แวร์ทุกรุ่นเราต้องเขียนบันทึกย่อประจำรุ่น ตัวอย่างเช่นต่อไปนี้เป็นคำศัพท์ที่ฉันเพิ่มเมื่อฉันเขียนบันทึกย่อประจำรุ่น:

วันวางจำหน่าย
แก้ไขข้อผิดพลาด

เพียงพอหรือมีอะไรอีกหรือไม่

release

— CoolProgrammer
แหล่งที่มา

สิ่งนี้ดูเหมือนซ้ำกับprogrammers.stackexchange.com/questions/66377/…

อย่าลืมเพิ่มคุณสมบัติ

— ratchet freak

คำตอบ:

ฉันคิดว่าการติดตามจะทำให้วิธีการปฏิบัติที่ดี

// วันที่เกี่ยวข้อง

วันวางจำหน่าย

// คุณสมบัติที่เกี่ยวข้อง

เพิ่มคุณสมบัติ
นำออกแล้ว
เปลี่ยนคุณสมบัติแล้ว

// Bug ที่เกี่ยวข้อง

แก้ไขข้อบกพร่องแล้ว
ข้อบกพร่องที่ไม่ได้แก้ไข

// การพึ่งพาเกี่ยวข้องกับ

รายการของการพึ่งพา

// การทดสอบที่เกี่ยวข้อง

ผลการทดสอบหน่วย
ผลการทดสอบการยอมรับ

// การควบคุมเวอร์ชันเกี่ยวข้องกับ

หมายเหตุแท็ก
หมายเลขการแก้ไข

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

ผู้ใช้ส่วนใหญ่ไม่สนใจเกี่ยวกับผลการทดสอบ พวกเขาคาดหวังว่ามันจะมีคุณภาพสูงไม่ว่าจะมีบันทึกย่อประจำรุ่นอย่างไร

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

— Md Mahbubur Rahman
แหล่งที่มา

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

— jk

@jk ใช่คุณถูก. ฉันได้แก้ไขคำตอบของฉันเป็นความคิดเห็นที่ดีของคุณ

— Md Mahbubur Rahman

— Henrik

@Henrik บันทึกย่อประจำรุ่นอาจมีประโยชน์สำหรับคนอื่นที่ไม่ใช่ผู้ใช้ปลายทาง

— jk

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

— ddyer
แหล่งที่มา

แต่ละบรรทัดอาจสูญเสีย 10% ของผู้อ่านทั่วไปที่ไม่สนใจ (หรือขี้เกียจ) ผู้อ่านเหล่านั้นเป็นสิ่งที่บันทึกย่อประจำรุ่นของคุณไม่ได้ถูกเขียนขึ้น คนที่ใส่ใจในสิ่งที่คุณทำจะอ่านพวกเขาทั้งหมดและขอบคุณสำหรับแต่ละบรรทัดที่เกี่ยวข้อง - คุณจะต้องระมัดระวังเกี่ยวกับการรวมถึงปุยที่จำเป็นต้องใช้ในเอกสารที่เหมาะสม

— gbjbaanb