Cung cấp cho người dùng thông tin lịch sử sửa đổi chương trình?

Một hạn chế của chương trình mà tôi duy trì là người dùng cuối thường không biết những thay đổi đã được thực hiện. Để khắc phục điều này, tôi muốn cho người dùng của mình một danh sách đơn giản các thay đổi được thực hiện cho chương trình của họ. Có một phương pháp / phương pháp tốt để làm theo sẽ tạo ra một danh sách dễ cập nhật mà sau đó có thể được đưa vào giao diện người dùng không?

Ví dụ: Tôi có nên lưu trữ mọi thứ trong tệp XML được đọc thành biểu mẫu không? Lịch sử thay đổi có nên đi vào cơ sở dữ liệu?

Lưu ý: Chương trình là Winforms (C # 4.0).

CẬP NHẬT

Dựa trên phản hồi tuyệt vời, tôi đã quyết định sử dụng SQLite làm nơi lưu trữ thông tin của mình và sẽ cung cấp cho người dùng danh sách các thay đổi theo thời gian trong điều khiển TreeView.

Người dùng thường không quan tâm đến mọi thứ giống như bạn làm. Mặc dù bạn có thể lười biếng và chỉ đơn giản là xuất bản danh sách lỗi của mình, nhưng sẽ tốt hơn nhiều nếu bạn dành một chút thời gian và làm nổi bật những thay đổi trong ngôn ngữ của người dùng.

Điều này có nghĩa là mất chi tiết. Đối với những người muốn tất cả các chi tiết, bạn có thể bao gồm một danh sách đầy đủ các vấn đề được giải quyết - nhưng nói chung, ghi chú phát hành của bạn chỉ nên hiển thị, theo thứ tự này:

1. Chức năng chính mới, trong ngôn ngữ của người dùng .
2. Thay đổi trong quy trình làm việc, có thể với một sự biện minh. Ví dụ: "Hộp thoại in đã được sắp xếp hợp lý, giờ đây bạn có thể tìm thấy các tùy chọn bố cục trang trên trang in, thay vì vị trí cũ của chúng trong Tùy chọn Tài liệu."
3. Sửa lỗi lớn, trong ngôn ngữ của người dùng . Ví dụ: "Sự cố ít xảy ra hơn khi mở tệp trên 2 GB" thay vì "Đã sửa lỗi tràn bộ đệm trong mt_file_read cho đầu vào> 2GB"
4. Một bản tóm tắt về bất kỳ thay đổi nhỏ nào đối với quy trình làm việc và các tính năng mới nhỏ bé
5. Nói chung, người dùng không quan tâm đến các sửa lỗi nhỏ, vì vậy chỉ cần nói "và sửa lỗi" hoặc tương tự. Một lần nữa, bạn có thể cung cấp một liên kết đến các chi tiết đầy đủ cho các lập trình viên trong khán giả. ;)

Đây là công việc nhiều hơn và người dùng của bạn sẽ thực sự đánh giá cao sự chú ý đến chi tiết.

Bất kỳ trình theo dõi vấn đề tử tế nào cũng tạo ra các ghi chú phát hành (dựa trên các câu chuyện đã đóng trong một bản phát hành). Nhúng tệp đó dưới dạng tệp văn bản và hiển thị nó ở bất cứ đâu bạn muốn trong ứng dụng của mình.

Câu hỏi đầu tiên bạn cần trả lời là nếu người dùng của bạn quan tâm. Không cần thực hiện bất kỳ chức năng hoặc thành phần giao diện người dùng nào để thêm thứ gì đó mà người dùng không muốn hoặc không cần. Đó chỉ là nhiều mã cần được kiểm tra và xác nhận. Nếu không có yêu cầu nào về thông tin này được hiển thị trong ứng dụng, bạn chỉ cần mạ vàng các yêu cầu - một phản mẫu đã biết.

Nếu người dùng của bạn muốn có thông tin này, bạn cần xác định cách cung cấp thông tin đó. Điều đó nên được thúc đẩy bởi người dùng, thông qua các yêu cầu mà họ cung cấp. Bạn dường như muốn trình bày nó như một công cụ có thể truy cập thông qua giao diện người dùng. Tuy nhiên, có nhiều tùy chọn khác cần được xem xét và thảo luận với người dùng của bạn (hoặc tập hợp con của người dùng có thể muốn thông tin này). Các tùy chọn có thể bao gồm "thay đổi kể từ lần phát hành cuối" trong hướng dẫn README hoặc hướng dẫn sử dụng, tệp thay đổi cùng với hướng dẫn README hoặc hướng dẫn sử dụng hoặc trang web trên trang web của sản phẩm mô tả các thay đổi trong phiên bản mới nhất với khả năng xem các thay đổi giữa phiên bản mới nhất. Tùy thuộc vào định dạng tệp mà bạn sử dụng để thay đổi,

Bất kể bạn cung cấp nó như thế nào, đừng làm điều đó vì bạn muốn, nhưng vì người dùng của bạn muốn nó. Mặt khác, bạn chỉ đang tạo ra công việc cho chính mình mà không thêm giá trị cho sản phẩm của bạn.