Bereitstellung von Informationen zum Programmversionsverlauf für Benutzer?

8

Eine Einschränkung eines von mir gepflegten Programms besteht darin, dass die Endbenutzer häufig nicht wissen, welche Änderungen vorgenommen wurden. Um dies zu beheben, möchte ich meinen Benutzern eine vereinfachte Liste der an ihrem Programm vorgenommenen Änderungen zeigen. Gibt es eine gute Methodik / einen guten Ansatz, mit dem eine einfach zu aktualisierende Liste erstellt werden kann, die dann in die Benutzeroberfläche eingegeben werden kann?

Zum Beispiel: Soll ich alles in einer XML-Datei speichern, die in ein Formular eingelesen wird? Sollte der Änderungsverlauf in eine Datenbank aufgenommen werden?

Hinweis: Das Programm ist Winforms (C # 4.0).

AKTUALISIEREN

Aufgrund des hervorragenden Feedbacks habe ich mich für SQLite als Informationsspeicher entschieden und werde den Benutzern eine chronologische Liste der Änderungen in einem TreeView-Steuerelement zur Verfügung stellen.

John M.
quelle
1
Lassen Sie sie einfach wissen, wenn Sie ihren Käse bewegt haben.
JeffO
Vielleicht möchten Sie dies auf UX.se
Ilari Kajaste

Antworten:

13

Benutzer kümmern sich im Allgemeinen nicht so um Dinge wie Sie. Während Sie faul sein und einfach Ihre Fehlerliste veröffentlichen können, ist es weitaus besser, wenn Sie sich etwas Zeit nehmen und die Änderungen in der Sprache des Benutzers hervorheben.

Dies bedeutet Detailverlust. Für diejenigen, die alle Details wünschen, können Sie eine vollständige Liste der angesprochenen Probleme hinzufügen. Im Allgemeinen sollten Ihre Versionshinweise jedoch nur in dieser Reihenfolge angezeigt werden:

  1. Wichtige neue Funktionen in der Sprache des Benutzers .
  2. Änderungen im Workflow, möglicherweise mit Begründung. Beispiel: "Der Druckdialog wurde optimiert. Sie finden jetzt Seitenlayoutoptionen auf der Druckseite anstelle der alten Position unter Dokumentoptionen."
  3. Wichtige Fehlerbehebungen in der Sprache des Benutzers . Beispiel: "Abstürze treten beim Öffnen von Dateien über 2 GB weniger häufig auf" als "Behobener Pufferüberlauf in mt_file_read für Eingaben> 2 GB"
  4. Eine Zusammenfassung aller geringfügigen Änderungen am Workflow und winziger neuer Funktionen
  5. Im Allgemeinen interessieren sich Benutzer nicht für kleinere Fehlerkorrekturen. Sagen Sie einfach "und Fehlerkorrekturen" oder ähnliches. Auch hier können Sie den Programmierern im Publikum einen Link zu allen Details bereitstellen. ;)

Dies ist mehr Arbeit, und Ihre Benutzer werden die Liebe zum Detail wirklich zu schätzen wissen.

Alex Feinman
quelle
2
+1 - Benutzersprache ist definitiv wichtig. Ich werde mich auf benutzerrelevante Änderungen konzentrieren (nicht darauf, dass ich eine Methode / Klasse / usw. umgestalte), die sich auf die Verwendung des Programms auswirken.
John M
5

Jeder anständige Issue-Tracker generiert Versionshinweise (basierend auf den geschlossenen Storys in einer Veröffentlichung). Betten Sie das als Textdatei ein und zeigen Sie es an einer beliebigen Stelle in Ihrer App an.

Sergiu Damian
quelle
1
+1 Normalerweise gibt es ein separates Feld für den Versionshinweis, damit die Probleme in Alex 'Antwort vermieden werden können
jk.
2

Die erste Frage, die Sie beantworten müssen, ist, ob es Ihre Benutzer interessiert. Es ist nicht erforderlich, Funktionen oder Benutzeroberflächenkomponenten zu implementieren, um etwas hinzuzufügen, das Benutzer nicht möchten oder benötigen. Das ist nur mehr Code, der getestet und validiert werden muss. Wenn diese Informationen nicht in der Anwendung angezeigt werden müssen, vergolden Sie nur die Anforderungen - ein bekanntes Antimuster.

Wenn Ihre Benutzer diese Informationen wünschen, müssen Sie festlegen, wie sie verfügbar gemacht werden sollen. Dies sollte von den Benutzern durch die von ihnen bereitgestellten Anforderungen gesteuert werden. Sie möchten es anscheinend als Tool präsentieren, auf das über die Benutzeroberfläche zugegriffen werden kann. Es gibt jedoch viele andere Optionen, die in Betracht gezogen und mit Ihren Benutzern (oder der Untergruppe der Benutzer, die diese Informationen möglicherweise wünschen) besprochen werden sollten. Mögliche Optionen sind "Änderungen seit der letzten Version" in der README-Datei oder im Benutzerhandbuch, eine Änderungsprotokolldatei neben der README-Datei oder im Benutzerhandbuch oder eine Webseite auf der Produktwebsite, auf der die Änderungen in der neuesten Version beschrieben werden und Änderungen zwischen diesen angezeigt werden können letzte Version. Abhängig vom Dateiformat, das Sie für die Änderungen verwenden,

Unabhängig davon, wie Sie es bereitstellen, tun Sie es nicht, weil Sie möchten, sondern weil Ihre Benutzer es möchten. Andernfalls schaffen Sie nur Arbeit für sich selbst, die Ihrem Produkt keinen Wert hinzufügt.

Thomas Owens
quelle
Sie werden gelegentlich die Funktionalität wünschen (haben Sie die von uns gewünschten Änderungen vorgenommen?) - Ich werde auch von einer chronologischen Liste der Änderungen profitieren - erstaunlich, was Sie in 6 Monaten vergessen können.
John M
@ JohnM Haben sie dir gesagt, dass sie die Funktionalität wollen? Haben sie Ihnen gesagt, dass sie es innerhalb der Anwendung anzeigen möchten? Keine goldene Platte. Erfüllen Sie nur die festgelegten Anforderungen und erreichen Sie diese auf einfachste Weise.
Thomas Owens
Das Anzeigen der Liste in der Anwendung kann so einfach sein, dass der URL ein anklickbarer Link hinzugefügt wird, um die Änderungsinformationen auf der Unternehmenswebsite in einem Menü oder über einen Dialog (z. B. ein LinkLabel-Steuerelement) zu ändern. Wenn Sie wirklich Offline-Zugriff benötigen, können Sie jederzeit eine Verknüpfung zu einer statischen HTML-Datei herstellen, die mit der Anwendung installiert wurde.
Stephen C. Steel