Cách tạo trang nhật ký thay đổi: mục, thẻ, RSS và “Có gì mới”
Một trang nhật ký thay đổi là danh sách theo ngày về những gì đã thay đổi trong sản phẩm của bạn, mới nhất lên đầu, được viết cho những người dùng nó. Để tạo một trang như vậy, bạn cần các mục có ngày, tiêu đề rõ ràng, phần giải thích ngắn và một thẻ (Mới, Cải tiến, Đã sửa), một trang liệt kê chúng, một URL riêng cho mỗi mục, và lý tưởng là một nguồn cấp RSS cùng cách cho người dùng biết có điều gì mới. Đây là một trong những thứ đơn giản nhất bạn có thể xây dựng, và quyết định chính là nơi các mục nằm: dưới dạng tệp trong website, hay trong cơ sở dữ liệu có trang quản trị.
Vì sao nhật ký thay đổi đáng có
Nhật ký thay đổi cho khách hàng và khách tiềm năng thấy sản phẩm đang được bảo trì. Nó cho bộ phận hỗ trợ và bán hàng một liên kết để gửi khi ai đó hỏi “có làm được X chưa?”. Nó cũng là nơi khép vòng phản hồi: khi một tính năng được yêu cầu ra mắt, mục nhật ký là thứ bạn chỉ người ta đến xem. Nếu bạn vận hành cổng phản hồi khách hàng, hãy liên kết các yêu cầu đã hoàn thành thẳng tới mục của chúng.
Nhật ký thay đổi không phải là lịch sử commit nội bộ của bạn. “Refactor dịch vụ thanh toán” không có nghĩa gì với người dùng. “Hóa đơn giờ hiển thị mã số thuế VAT của công ty bạn” thì có.
Trang cần có những gì
Nội dung cho mỗi mục
| Trường | Ghi chú |
|---|---|
| Tiêu đề | Điều gì đã thay đổi, từ góc nhìn của người dùng |
| Ngày | Ngày xuất bản, hiển thị trên trang |
| Thẻ | Mới, Cải tiến, Đã sửa (và có thể là Đã xóa hoặc Bảo mật) |
| Nội dung | Vài câu hoặc gạch đầu dòng; cách dùng, ai được nhận |
| Ảnh hoặc video | Tùy chọn; một ảnh chụp màn hình giúp nhiều hơn một đoạn văn |
| Slug | URL của mục, ví dụ /changelog/invoice-vat-numbers |
| Trạng thái | Nháp hoặc đã xuất bản, cùng ngày xuất bản đã lên lịch nếu cần |
Các trang
- Trang chỉ mục nhật ký: mới nhất lên đầu, có nút lọc theo thẻ và phân trang đơn giản hoặc “tải thêm”.
- Trang mục: một mục cho mỗi URL, để có thể liên kết và chia sẻ.
- Nguồn cấp RSS hoặc Atom: cho phép người dùng và công cụ theo dõi cập nhật mà không cần email.
- Trang quản trị (chỉ với phiên bản cơ sở dữ liệu): viết, xem trước, lên lịch và xuất bản mục.
Tiện ích trong app
- Huy hiệu “Có gì mới”: một chấm trên mục menu khi có các mục mà người dùng chưa xem. Lưu ngày của mục cuối cùng họ đã mở, theo từng người dùng hoặc trong trình duyệt.
- Bản tóm tắt qua email: một bản tóm tắt gửi đến người dùng đã chọn nhận. Cần một nhà cung cấp gửi thư; xem cách gửi email từ app.
Quyết định chính: tệp hay cơ sở dữ liệu
Mục dưới dạng tệp trong website
Mỗi mục là một tệp Markdown trong dự án. Xuất bản một mục nghĩa là thêm một tệp và triển khai lại. Đây là cách đơn giản và vững chắc nhất: không cần cơ sở dữ liệu, không cần đăng nhập quản trị, không có gì để bảo mật, và các trang có thể được render trước để tải nhanh và dễ đọc với công cụ tìm kiếm.
Cách này phù hợp với các nhóm mà người viết mục thoải mái khi nhờ công cụ tạo app AI hoặc chỉnh sửa tệp.
Mục trong cơ sở dữ liệu có trang quản trị
Các mục nằm trong một bảng, và một trang quản trị riêng cho phép bất kỳ ai trong nhóm viết, xem trước, lên lịch và xuất bản. Cách này phù hợp với các nhóm mà bộ phận marketing hoặc hỗ trợ viết cập nhật, hoặc khi bạn muốn xuất bản theo lịch hoặc các mục theo từng nhóm người dùng (ví dụ, chỉ hiển thị tính năng doanh nghiệp cho khách hàng doanh nghiệp).
Cái giá là phải xây dựng và duy trì nhiều hơn: đăng nhập quản trị, lưu trữ ảnh, và đảm bảo các trang công khai vẫn được công cụ tìm kiếm đọc được, điều mà một trang chỉ tải mục trong trình duyệt có thể không đáp ứng.
| Tệp | Cơ sở dữ liệu + quản trị | |
|---|---|---|
| Ai có thể xuất bản | Bất kỳ ai chỉnh sửa dự án | Bất kỳ ai có tài khoản quản trị |
| Thiết lập | Tối thiểu | Đăng nhập, lưu trữ, giao diện quản trị |
| SEO | Dễ (trang được render trước) | Cần cẩn thận để trang được render trên máy chủ hoặc render trước |
| Lên lịch | Xuất bản khi triển khai | Có thể lên lịch theo ngày |
| Chi phí lưu trữ | Tĩnh | Cần app đang chạy và cơ sở dữ liệu |
Viết mục mà người đọc thực sự đọc
- Bắt đầu bằng lợi ích. “Xuất báo cáo ra Excel” hay hơn “Module xuất mới”.
- Nói rõ ai được dùng. Tất cả các gói, chỉ gói Pro, đang triển khai trong tuần này.
- Cho thấy nó. Một ảnh chụp màn hình hoặc một đoạn clip ngắn.
- Gom các lỗi nhỏ lại. Một mục “Sửa lỗi và cải tiến” hằng tuần với các gạch đầu dòng giúp trang không bị ngập.
- Thẳng thắn về việc gỡ bỏ. Nếu có gì sắp biến mất, hãy nói khi nào và nên dùng gì thay thế.
Prompt đầu tiên hiệu quả
Thêm một nhật ký thay đổi công khai vào website của chúng tôi tại /changelog. Mỗi mục là một tệp Markdown với tiêu đề, ngày, thẻ (Mới, Cải tiến hoặc Đã sửa), ảnh bìa tùy chọn và nội dung. Trang chỉ mục liệt kê các mục mới nhất trước, với ngày, thẻ và đoạn đầu tiên, có các nút lọc theo thẻ, và hiển thị 10 mục mỗi trang. Mỗi mục có trang riêng tại /changelog/<slug> với tiêu đề và mô tả trang rõ ràng cho công cụ tìm kiếm. Thêm nguồn cấp RSS tại /changelog/rss.xml. Tạo ba mục mẫu. Khớp với thiết kế website hiện có, giữ cho dễ đọc trên điện thoại, và render trước các trang để tải nhanh.
Với phiên bản cơ sở dữ liệu, thay câu đầu tiên bằng “Lưu các mục trong cơ sở dữ liệu với trạng thái nháp/đã xuất bản và ngày xuất bản, và thêm một trang quản trị có mật khẩu để viết, xem trước và xuất bản chúng.”
Các bước xây dựng
- Quyết định tệp hay cơ sở dữ liệu theo bảng ở trên.
- Xây dựng trang chỉ mục và trang mục với vài mục mẫu.
- Thêm thẻ và bộ lọc.
- Thêm nguồn cấp RSS và liên kết từ trang.
- Thêm tiêu đề trang, mô tả và mục sitemap cho từng mục. Hướng dẫn SEO cho website tạo bằng AI của chúng tôi bao quát những điều cơ bản.
- Trang quản trị và đăng nhập, nếu bạn chọn hướng cơ sở dữ liệu.
- Huy hiệu “Có gì mới” trong app của bạn.
- Viết các mục thật cho vài tháng gần nhất để trang không ra mắt trống trơn.
Những lỗi thường gặp
- Sao chép commit message. Viết cho người dùng, không phải cho lập trình viên.
- Một trang khổng lồ không có URL riêng cho từng mục. Không ai liên kết được tới một thay đổi cụ thể, và công cụ tìm kiếm thấy một trang thay vì nhiều trang.
- Cập nhật ngừng sau một tháng. Một nhật ký lần cuối được cập nhật cách đây một năm gợi ý sản phẩm đã bị bỏ rơi. Hãy đặt một nhịp mà bạn có thể duy trì.
- Chỉ tải mục trong trình duyệt. Công cụ tìm kiếm và trình xem trước liên kết có thể thấy trang trống. Hãy render trước hoặc render trên máy chủ.
- Trộn lẫn sự cố. Thời gian ngừng hoạt động thuộc về một trang trạng thái, không thuộc nhật ký thay đổi.
Khi một công cụ nhật ký được lưu trữ là lựa chọn tốt hơn
Có các công cụ nhật ký và cập nhật sản phẩm được lưu trữ, một số đi kèm bảng phản hồi hoặc tiện ích trong app. Chúng đáng giá nếu bạn muốn popup trong app, nhắm mục tiêu theo nhóm người dùng và phân tích mà không phải tự xây, hoặc nếu nhóm bạn đã trả tiền cho một công cụ có sẵn tính năng này. Phần mềm trung tâm trợ giúp hoặc blog của bạn cũng có thể đã có định dạng phù hợp.
Tự xây dựng có ý nghĩa khi bạn muốn nhật ký nằm trên tên miền riêng, với thiết kế riêng, và được công cụ tìm kiếm lập chỉ mục đầy đủ; với một danh sách các mục có ngày đơn giản, công việc không nhiều.
Xây dựng với Mythex
Trên Mythex, bạn có thể yêu cầu tác nhân thêm nhật ký thay đổi vào một dự án hiện có hoặc xây dựng nó như một website nhỏ riêng, và xem nó trong bản xem trước trực tiếp khi đang được tạo. Phiên bản dựa trên tệp không cần cơ sở dữ liệu. Nếu bạn chọn phiên bản quản trị, tác nhân thêm cơ sở dữ liệu Postgres riêng khi các mục cần được lưu (hoặc gõ /database), và ảnh chụp màn hình được đặt trong lưu trữ tệp của dự án. Đăng nhập quản trị là thứ bạn thêm bằng cách xác thực riêng của mình (công thức thêm đăng nhập).
Các app Mythex mới thường là ứng dụng một trang phía client, và công thức SEO lưu ý rằng chúng yếu hơn cho tìm kiếm, vì vậy nếu bạn muốn các mục được tìm thấy trên công cụ tìm kiếm, hãy yêu cầu trang nhật ký tĩnh hoặc được render trước. Cùng công thức đó cũng nói về tiêu đề, mô tả và sitemap. Để có điểm khởi đầu với nhật ký tích hợp sẵn, xem mẫu trung tâm kiến thức sản phẩm.
Câu hỏi thường gặp
Một mục nhật ký thay đổi cần có những gì?
Ngày, một tiêu đề ngắn cho biết điều gì đã thay đổi đối với người dùng, vài câu hoặc gạch đầu dòng giải thích, một thẻ như Mới, Cải tiến hoặc Đã sửa, và tùy chọn là ảnh chụp màn hình cùng liên kết tới chi tiết hơn.
Nhật ký thay đổi có cần cơ sở dữ liệu không?
Không nhất thiết. Nếu một hoặc hai người đăng cập nhật, các mục có thể nằm dưới dạng tệp Markdown trong website và được xuất bản cùng mỗi lần triển khai. Hãy dùng cơ sở dữ liệu khi những người không chuyên kỹ thuật cần viết và lên lịch mục từ một trang quản trị.
Tôi nên cập nhật nhật ký thay đổi bao lâu một lần?
Mỗi khi có điều gì đó người dùng sẽ nhận ra đã thay đổi. Nhiều sản phẩm nhỏ gom các thay đổi theo tuần hoặc hai tuần một lần; điều quan trọng là giữ một nhịp đều đặn để trang luôn có vẻ đang hoạt động.
Nhật ký thay đổi có tốt cho SEO không?
Có thể giúp một chút: mỗi mục là một trang có thể được công cụ tìm kiếm thu thập về một tính năng, và một trang được cập nhật thường xuyên cho thấy sản phẩm đang hoạt động. Hãy cho mỗi mục một URL riêng và một tiêu đề mô tả rõ ràng.