Change log là gì?

11/01/2022
Posted by: admin
Category: Kiến thức

Change log là gì?

Định nghĩa change log

Bảng theo dõi thay đổi - change log là một tệp chứa danh sách các thay đổi đáng chú ý được sắp xếp theo thứ tự thời gian cho mỗi phiên bản của một dự án.

Quản lý thay đổi bằng change log

Tại sao giữ một bảng theo dõi thay đổi - change log?

Để giúp người dùng và người cộng tác dễ dàng biết chính xác những thay đổi đáng chú ý nào đã được thực hiện giữa mỗi bản phát hành (hoặc phiên bản) của dự án.

Ai cần một bảng theo dõi thay đổi - change log?

Mọi người trong dự án. Cho dù người tiêu dùng hay nhà phát triển, người dùng cuối cùng là những con người quan tâm đến những gì trong sản phẩm. Khi sản phẩm thay đổi, mọi người muốn biết tại sao và như thế nào.

Làm cách nào để tạo một bảng theo dõi thay đổi - change log tốt?

Nguyên tắc hướng dẫn xây dựng change log

Change log dành cho con người, không phải máy móc.
Nên có một mục cho mọi phiên bản.
Các loại thay đổi giống nhau nên được nhóm lại.
Các phiên bản và phần đều có thể liên kết được.
Phiên bản mới nhất có trước.
Ngày phát hành của mỗi phiên bản được hiển thị.
Đề cập đến việc bạn có theo dõi Phiên bản ngữ nghĩa hay không.

Các loại thay đổi phù hợp cho change log

Đã thêm cho các tính năng mới.
Đã thay đổi vì những thay đổi trong chức năng hiện có.
Không được chấp nhận cho các tính năng sắp bị loại bỏ.
Đã xóa đối với các tính năng hiện đã bị loại bỏ.
Đã sửa cho mọi bản sửa lỗi.
Bảo mật trong trường hợp có lỗ hổng.

Làm cách nào để giảm bớt nỗ lực để duy trì một bảng theo dõi thay đổi - change log?

Giữ phần Chưa phát hành ở trên cùng để theo dõi những thay đổi sắp tới. Điều này phục vụ hai mục đích:

Mọi người có thể thấy những thay đổi mà họ có thể mong đợi trong các bản phát hành sắp tới
Tại thời điểm phát hành, bạn có thể chuyển các thay đổi của phần Chưa phát hành sang phần phiên bản phát hành mới.

Dưới đây là một số cách khác giúp cho việc cập nhật change log hiệu quả hơn.
Nhật ký cam kết khác nhau:
Sử dụng bản ghi cam kết khác với các bản ghi thay đổi là một ý tưởng tồi. Những thứ như cam kết hợp nhất, cam kết có tiêu đề khó hiểu, thay đổi tài liệu, v.v. Mục đích của cam kết là ghi lại một bước trong quá trình phát triển của mã nguồn. Một số dự án xóa các cam kết, một số thì không. Mục đích của mục nhập bảng thay đổi là ghi lại sự khác biệt đáng chú ý, thường là qua nhiều cam kết, để thông báo chúng một cách rõ ràng với người dùng cuối.

Bỏ qua những nội dung không dùng nữa:
Khi mọi người nâng cấp từ phiên bản này lên phiên bản khác, cần phải rõ ràng khi nào một thứ gì đó sẽ bị hỏng. Có thể nâng cấp lên phiên bản liệt kê những gì không dùng nữa, xóa những gì không dùng nữa, sau đó nâng cấp lên phiên bản mà những gì không dùng nữa sẽ trở thành loại bỏ. Nếu bạn không làm gì khác, hãy liệt kê các nội dung không dùng nữa, loại bỏ và bất kỳ thay đổi vi phạm nào trong bảng thay đổi của bạn.

Ngày tháng:
Định dạng ngày tháng theo khu vực khác nhau trên toàn thế giới và thường rất khó để tìm thấy một định dạng ngày tháng thân thiện với con người cảm thấy trực quan đối với tất cả mọi người. Ưu điểm của các ngày được định dạng như 2017-07-17 là chúng tuân theo thứ tự từ các đơn vị lớn nhất đến nhỏ nhất: năm, tháng và ngày. Định dạng này cũng không trùng lặp theo những cách không rõ ràng với các định dạng ngày khác, không giống như một số định dạng khu vực chuyển đổi vị trí của số tháng và ngày. Những lý do này và thực tế là định dạng ngày này là một tiêu chuẩn ISO, là lý do tại sao nó là định dạng ngày được khuyến nghị cho các mục nhập thay đổi.

Các bài viết liên quan

Số 229 Tây Sơn, Đống Đa, Hà Nội