วิธีสร้างหน้าบันทึกการเปลี่ยนแปลง: รายการ แท็ก RSS และ "มีอะไรใหม่"

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

ทำไมบันทึกการเปลี่ยนแปลงจึงคุ้มค่า

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

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

หน้าต้องมีอะไรบ้าง

เนื้อหาของแต่ละรายการ

หน้าต่าง ๆ

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

ส่วนเสริมในแอป

• ป้าย "มีอะไรใหม่": จุดบนเมนูเมื่อมีรายการที่ผู้ใช้ยังไม่ได้เห็น เก็บวันที่ของรายการล่าสุดที่ผู้ใช้เปิดดู แยกต่อผู้ใช้หรือในเบราว์เซอร์
• สรุปทางอีเมล: สรุปส่งให้ผู้ใช้ที่เลือกรับ ต้องใช้ผู้ให้บริการส่งอีเมล ดู วิธีส่งอีเมลจากแอปของคุณ

การตัดสินใจหลัก: ไฟล์หรือฐานข้อมูล

รายการเป็นไฟล์ในเว็บไซต์

แต่ละรายการคือไฟล์ Markdown ในโปรเจกต์ การเผยแพร่รายการหมายถึงการเพิ่มไฟล์และ deploy ใหม่ นี่คือวิธีที่ง่ายและทนทานที่สุด ไม่มีฐานข้อมูล ไม่มีการเข้าสู่ระบบแอดมิน ไม่มีอะไรต้องรักษาความปลอดภัย และหน้าสามารถ pre-render เพื่อให้โหลดเร็วและเครื่องมือค้นหาอ่านได้ง่าย

เหมาะกับทีมที่คนเขียนรายการสบายใจที่จะขอให้เครื่องมือสร้างด้วย AI ช่วย หรือแก้ไขไฟล์เอง

รายการในฐานข้อมูลพร้อมหน้าแอดมิน

รายการอยู่ในตาราง และหน้าแอดมินส่วนตัวให้ใครก็ได้ในทีมเขียน ดูตัวอย่าง ตั้งเวลา และเผยแพร่ได้ เหมาะกับทีมที่ฝ่ายการตลาดหรือฝ่ายซัพพอร์ตเป็นผู้เขียนการอัปเดต หรือเมื่อคุณต้องการเผยแพร่ตามกำหนดเวลา หรือรายการเฉพาะกลุ่ม (เช่น แสดงฟีเจอร์องค์กรเฉพาะลูกค้าองค์กร)

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

การเขียนรายการที่คนอ่าน

• เริ่มด้วยประโยชน์ "ส่งออกรายงานเป็น Excel" ดีกว่า "โมดูลการส่งออกใหม่"
• บอกว่าใครได้รับ ทุกแพ็กเกจ เฉพาะ Pro กำลังทยอยเปิดตัวในสัปดาห์นี้
• แสดงให้เห็น ภาพหน้าจอหนึ่งภาพหรือคลิปสั้น ๆ
• จัดกลุ่มการแก้ไขเล็ก ๆ รายการสรุปรายสัปดาห์ "การแก้ไขและการปรับปรุง" เป็นข้อ ช่วยไม่ให้หน้าถูกท่วมไปด้วยรายการเล็ก ๆ
• ซื่อสัตย์เรื่องการลบออก หากบางอย่างจะถูกยกเลิก ให้บอกว่าเมื่อไรและควรใช้อะไรแทน

พรอมต์แรกที่ใช้ได้จริง

เพิ่มบันทึกการเปลี่ยนแปลงสาธารณะในเว็บไซต์ของเราที่ /changelog แต่ละรายการคือไฟล์ Markdown ที่มีชื่อเรื่อง วันที่ แท็ก (ใหม่ ปรับปรุง หรือแก้ไข) ภาพปกที่ไม่บังคับ และเนื้อหา หน้าดัชนีแสดงรายการเรียงจากใหม่สุดก่อน พร้อมวันที่ แท็ก และย่อหน้าแรก มีปุ่มกรองตามแท็ก และแสดง 10 รายการต่อหน้า แต่ละรายการมีหน้าของตัวเองที่ /changelog/<slug> พร้อมชื่อหน้าและคำอธิบายที่เหมาะสมสำหรับเครื่องมือค้นหา เพิ่ม RSS feed ที่ /changelog/rss.xml สร้างรายการตัวอย่างสามรายการ ให้เข้ากับดีไซน์ของเว็บไซต์ที่มีอยู่ อ่านได้บนโทรศัพท์ และ pre-render หน้าเพื่อให้โหลดเร็ว

สำหรับเวอร์ชันฐานข้อมูล ให้แทนประโยคแรกด้วย "เก็บรายการในฐานข้อมูลพร้อมสถานะร่าง/เผยแพร่และวันที่เผยแพร่ และเพิ่มหน้าแอดมินที่มีการป้องกันด้วยรหัสผ่านเพื่อเขียน ดูตัวอย่าง และเผยแพร่"

ขั้นตอนการสร้าง

1. ตัดสินใจว่าจะเป็นไฟล์หรือฐานข้อมูล ตามตารางด้านบน
2. สร้างหน้าดัชนีและหน้ารายการ พร้อมรายการตัวอย่างไม่กี่รายการ
3. เพิ่มแท็กและตัวกรอง
4. เพิ่ม RSS feed และลิงก์จากหน้า
5. เพิ่มชื่อหน้าและคำอธิบาย และรายการใน sitemap สำหรับแต่ละรายการ SEO สำหรับเว็บไซต์ที่สร้างด้วย AI ของเราครอบคลุมพื้นฐาน
6. หน้าแอดมินและการเข้าสู่ระบบ หากคุณเลือกเส้นทางฐานข้อมูล
7. ป้าย "มีอะไรใหม่" ในแอปของคุณ
8. เขียนรายการจริง สำหรับสองสามเดือนที่ผ่านมา เพื่อไม่ให้หน้าเปิดตัวว่างเปล่า

ข้อผิดพลาดที่พบบ่อย

• คัดลอกข้อความ commit เขียนให้ผู้ใช้ ไม่ใช่นักพัฒนา
• หน้าใหญ่หน้าเดียวที่ไม่มี URL ของแต่ละรายการ ไม่มีใครลิงก์ไปยังการเปลี่ยนแปลงเฉพาะได้ และเครื่องมือค้นหาเห็นหนึ่งหน้าแทนที่จะเป็นหลายหน้า
• การอัปเดตหยุดไปหนึ่งเดือน บันทึกการเปลี่ยนแปลงที่อัปเดตครั้งสุดท้ายเมื่อปีที่แล้วบ่งบอกว่าผลิตภัณฑ์ถูกทิ้งร้าง ตั้งจังหวะที่คุณทำต่อได้
• โหลดรายการเฉพาะในเบราว์เซอร์ เครื่องมือค้นหาและการแสดงตัวอย่างลิงก์อาจเห็นหน้าว่างเปล่า ให้ pre-render หรือ render บนเซิร์ฟเวอร์
• ปนเรื่องเหตุขัดข้อง การหยุดให้บริการควรอยู่ในหน้าสถานะ ไม่ใช่บันทึกการเปลี่ยนแปลง

เมื่อเครื่องมือบันทึกการเปลี่ยนแปลงแบบโฮสต์เป็นทางเลือกที่ดีกว่า

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

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

การสร้างด้วย Mythex

ใน Mythex คุณสามารถขอให้เอเจนต์เพิ่มบันทึกการเปลี่ยนแปลงในโปรเจกต์ที่มีอยู่ หรือสร้างเป็นเว็บไซต์เล็ก ๆ ของตัวเอง และดูในหน้าตัวอย่างสดขณะสร้าง เวอร์ชันที่ใช้ไฟล์ไม่ต้องมีฐานข้อมูล หากเลือกเวอร์ชันแอดมิน เอเจนต์จะเพิ่มฐานข้อมูล Postgres เฉพาะเมื่อต้องบันทึกรายการ (หรือพิมพ์ /database) และภาพหน้าจอจะอยู่ในที่เก็บไฟล์ของโปรเจกต์ การเข้าสู่ระบบแอดมินเป็นสิ่งที่คุณเพิ่มด้วยวิธีการยืนยันตัวตนของคุณเอง (สูตรเพิ่มการเข้าสู่ระบบ)

แอป Mythex ใหม่มักเป็นแอปหน้าเดียวที่เรนเดอร์ฝั่งไคลเอนต์ ซึ่งสูตร SEO ระบุว่าทำงานได้ไม่ดีนักกับการค้นหา ดังนั้นหากต้องการให้รายการถูกพบในการค้นหา ให้ขอหน้าบันทึกการเปลี่ยนแปลงแบบ static หรือ pre-render สูตรเดียวกันครอบคลุมชื่อเรื่อง คำอธิบาย และ sitemap สำหรับจุดเริ่มต้นที่มีบันทึกการเปลี่ยนแปลงในตัว ดูเทมเพลต ศูนย์ความรู้ผลิตภัณฑ์

คำถาม