¿Proporcionar a los usuarios información del historial de revisión del programa?

8

Una limitación de un programa que mantengo es que los usuarios finales a menudo no saben qué cambios se han realizado. Para remediar esto, me gustaría mostrar a mis usuarios una lista simplificada de los cambios realizados en su programa. ¿Hay una buena metodología / enfoque a seguir que crearía una lista fácil de actualizar que luego podría introducirse en la interfaz de usuario?

Por ejemplo: ¿Debo almacenar todo en un archivo XML que se lee en un formulario? ¿Debería el historial de cambios ir a una base de datos?

Nota: El programa es Winforms (C # 4.0).

ACTUALIZAR

Basado en los excelentes comentarios, he decidido utilizar SQLite como mi almacenamiento de información y proporcionaré a los usuarios una lista cronológica de cambios en un control TreeView.

John M
fuente
1
Solo avíseles cuando haya movido su queso.
JeffO
Es posible que desee preguntar esto en UX.se
Ilari Kajaste

Respuestas:

13

Los usuarios generalmente no se preocupan por las cosas de la misma manera que usted. Si bien puede ser flojo y simplemente publicar su lista de errores, es mucho mejor si se toma un poco de tiempo y resalta los cambios en el idioma del usuario.

Esto significa perder detalles. Para aquellos que desean todos los detalles, puede incluir una lista completa de los problemas abordados, pero en general sus notas de la versión solo deberían mostrar, en este orden:

  1. Nueva funcionalidad importante, en el idioma del usuario .
  2. Cambios en el flujo de trabajo, posiblemente con una justificación. Por ejemplo: "El diálogo de impresión se ha simplificado; ahora puede encontrar opciones de diseño de página en la página de impresión, en lugar de su ubicación anterior en Opciones de documento".
  3. Correcciones de errores importantes, en el idioma del usuario . Por ejemplo: "Los bloqueos son menos frecuentes al abrir archivos de más de 2 GB" en lugar de "Desbordamiento de búfer fijo en mt_file_read para entradas> 2 GB"
  4. Un resumen de cualquier cambio menor en el flujo de trabajo y pequeñas características nuevas
  5. En general, a los usuarios no les importan las correcciones de errores menores, así que solo diga "y correcciones de errores" o similares. Nuevamente, puede proporcionar un enlace a los detalles completos para los programadores en la audiencia. ;)

Esto es más trabajo, y sus usuarios realmente apreciarán la atención al detalle.

Alex Feinman
fuente
2
+1 - El usuario langague es definitivamente importante. Me voy a centrar en los cambios relevantes del usuario (no yo refactorizando un método / clase / etc.) que afectan la forma en que usan el programa.
John M
5

Cualquier rastreador de problemas decente genera notas de lanzamiento (basadas en las historias cerradas en un lanzamiento). Incruste eso como un archivo de texto y muéstrelo en cualquier lugar que desee en su aplicación.

Sergiu Damian
fuente
1
+1 generalmente hay un campo separado para la nota de lanzamiento, por lo que se pueden evitar los problemas en la respuesta de Alex
jk.
2

La primera pregunta que debe responder es si a sus usuarios les importa. No es necesario implementar ninguna funcionalidad o componentes de interfaz de usuario para agregar algo que los usuarios no quieren o necesitan. Eso es solo más código que necesita ser probado y validado. Si no hay ningún requisito para que esta información se muestre en la aplicación, solo está cumpliendo los requisitos: un antipatrón conocido.

Si sus usuarios desean esta información, debe determinar cómo ponerla a disposición. Eso debería ser impulsado por los usuarios, a través de los requisitos que proporcionan. Parece que quiere presentarlo como una herramienta accesible a través de la interfaz de usuario. Sin embargo, hay muchas otras opciones que deben considerarse y discutirse con sus usuarios (o el subconjunto de usuarios que podrían desear esta información). Las opciones posibles incluyen "cambios desde la última versión" en el archivo README o el manual del usuario, un archivo de registro de cambios junto con el archivo README o el manual del usuario, o una página web en el sitio web del producto que describe los cambios en la última versión con la capacidad de ver cambios entre Últimas Versiones. Dependiendo del formato de archivo que use para los cambios,

Independientemente de cómo lo entregue, no lo haga porque lo desee, sino porque sus usuarios lo desean. De lo contrario, solo está creando un trabajo para usted que no agrega valor a su producto.

Thomas Owens
fuente
Querrán la funcionalidad de vez en cuando (¿realizó los cambios que solicitamos?). También me beneficiaré con una lista cronológica de cambios, algo increíble que puede olvidar en 6 meses.
John M
@JohnM ¿Te han dicho que quieren la funcionalidad? ¿Te han dicho que quieren que se pueda ver desde dentro de la aplicación? No la placa de oro. Complete solo los requisitos establecidos y consígalos de la manera más simple posible.
Thomas Owens
Hacer que la lista sea visible desde la aplicación podría ser tan simple como agregar un enlace en el que se pueda hacer clic a la URL, la información de cambio en el sitio web de la compañía en un menú o sobre un diálogo (como un control LinkLabel). Si realmente necesita acceso sin conexión, siempre puede vincular a un archivo HTML estático instalado con la aplicación.
Stephen C. Steel