Menyediakan pengguna dengan informasi riwayat revisi program?

Salah satu batasan program yang saya pertahankan adalah bahwa pengguna akhir sering tidak tahu perubahan apa yang telah dibuat. Untuk memperbaiki ini, saya ingin menunjukkan kepada pengguna saya daftar perubahan sederhana yang dibuat untuk program mereka. Apakah ada metodologi / pendekatan yang baik untuk diikuti yang akan membuat daftar yang mudah diperbarui yang kemudian dapat dimasukkan ke dalam antarmuka pengguna?

Misalnya: Haruskah saya menyimpan semuanya dalam file XML yang dibaca ke dalam formulir? Haruskah riwayat perubahan masuk ke database?

Catatan: Program ini adalah Winforms (C # 4.0).

MEMPERBARUI

Berdasarkan umpan balik yang sangat baik saya telah memutuskan untuk menggunakan SQLite sebagai penyimpanan informasi saya dan akan memberikan daftar perubahan kronologis kepada pengguna dalam kontrol TreeView.

Pengguna umumnya tidak peduli tentang hal-hal dengan cara yang sama Anda lakukan. Meskipun Anda bisa malas dan cukup menerbitkan daftar bug Anda, jauh lebih baik jika Anda mengambil sedikit waktu dan menyoroti perubahan dalam bahasa pengguna.

Ini berarti kehilangan detail. Untuk mereka yang menginginkan semua detail, Anda dapat memasukkan daftar lengkap masalah yang dibahas - tetapi secara umum catatan rilis Anda hanya akan ditampilkan, dalam urutan ini:

1. Fungsionalitas baru utama, dalam bahasa pengguna .
2. Perubahan alur kerja, mungkin dengan justifikasi. Misalnya: "Dialog cetak telah disederhanakan; Anda sekarang dapat menemukan opsi tata letak halaman pada halaman cetak, alih-alih lokasi lama di bawah Opsi Dokumen."
3. Perbaikan bug utama, dalam bahasa pengguna . Misalnya: "Gangguan lebih jarang terjadi saat membuka file lebih dari 2 GB" daripada "Memperbaiki buffer overflow di mt_file_read untuk input> 2GB"
4. Sebuah Ringkasan dari kecil setiap perubahan untuk alur kerja dan fitur baru kecil
5. Secara umum, pengguna tidak peduli tentang perbaikan bug kecil, jadi katakan saja "dan perbaikan bug" atau sejenisnya. Sekali lagi, Anda dapat memberikan tautan ke detail lengkap untuk programer di antara audiens. ;)

Ini lebih banyak pekerjaan, dan pengguna Anda akan sangat menghargai perhatian terhadap detail.

Setiap pelacak masalah yang layak menghasilkan catatan rilis (berdasarkan cerita tertutup dalam rilis). Sematkan itu sebagai file teks dan perlihatkan di mana saja Anda suka di aplikasi Anda.

Pertanyaan pertama yang perlu Anda jawab adalah apakah pengguna Anda peduli. Tidak perlu menerapkan fungsionalitas atau komponen antarmuka pengguna untuk menambahkan sesuatu yang tidak diinginkan atau dibutuhkan pengguna. Itu hanya kode lagi yang perlu diuji dan divalidasi. Jika tidak ada persyaratan untuk informasi ini ditampilkan dalam aplikasi, Anda hanya perlu pelapisan emas - antipattern yang dikenal.

Jika pengguna Anda menginginkan informasi ini, Anda perlu menentukan bagaimana membuatnya tersedia. Itu harus didorong oleh pengguna, melalui persyaratan yang mereka berikan. Anda sepertinya ingin menyajikannya sebagai alat yang dapat diakses melalui antarmuka pengguna. Namun, ada banyak opsi lain yang harus dipertimbangkan, dan didiskusikan dengan pengguna Anda (atau bagian dari pengguna yang mungkin menginginkan informasi ini). Opsi yang mungkin termasuk "perubahan sejak rilis terakhir" dalam README atau manual pengguna, file changelog di samping README atau manual pengguna, atau halaman web di situs web produk yang menjelaskan perubahan dalam versi terbaru dengan kemampuan untuk melihat perubahan di antara versi terbaru. Bergantung pada format file yang Anda gunakan untuk perubahan,

Terlepas dari bagaimana Anda mengirimkannya, jangan lakukan itu karena Anda ingin, tetapi karena pengguna Anda menginginkannya. Jika tidak, Anda hanya menciptakan karya untuk diri sendiri yang tidak menambah nilai pada produk Anda.