Basado en un comentario y votos posteriores de Bug reopen vs. new :
Citar ID de errores en las notas del parche es simplemente ... muy hostil. - Krelp
Parece que al menos algunas personas sienten que hacer referencia a ID de errores en las notas del parche no es una buena idea. Soy un desarrollador bastante inexperto, así que me pregunto por qué ese es el caso.
issue-tracking
bug-report
software-patches
Travis Northcutt
fuente
fuente
Respuestas:
En mi opinión, es una buena práctica, suponiendo que sus usuarios tengan acceso de lectura a su base de datos de errores. Hay muchas ocasiones en que las personas esperan que se solucione un determinado error para decidir cuándo actualizar.
Creo que lo que está mal visto es solo citar la identificación del error y nada más. Siempre debe proporcionar una descripción que sea comprensible sin ir al rastreador de errores. Eso también le permite cambiar los rastreadores de errores en el futuro sin invalidar por completo sus notas de lanzamiento anteriores.
fuente
Es, como se dijo en el comentario citado ... hostil.
Antipático contigo mismo
Imagine el siguiente escenario. Estás viendo los registros en el control de código fuente. Te preguntas qué cambió un commit. En lugar de explicarlo en inglés simple, te dice:
Ejecutas el sistema de seguimiento de errores, esperando tener algo útil. El error # 1307 se informa como resuelto. En la descripción, ves:
Gracias, es muy útil. Ahora tiene que navegar al informe de errores # 1284 para leer que es un duplicado del error # 1113 que se refiere a los errores # 1112, # 1065 y # 1067.
Cinco minutos después, no tienes idea de lo que estás buscando al principio.
Un mensaje de registro de control de versiones mucho más útil sería:
De la misma manera, en el sistema de seguimiento de errores, el informe # 1307 podría explicarse por sí solo , recordando de qué se trataba el informe de errores # 1284 y cómo el nuevo es diferente del anterior.
Antipático con los clientes
Este no es el único problema de amistad.
Una segunda es que al hacer demasiada referencia sin información adicional, está haciendo que las notas del parche / registros de control de versiones / informes del sistema de seguimiento de errores no puedan utilizarse para alguien que no esté muy familiarizado con esos sistemas . Cuando maneja diariamente un sistema de seguimiento de errores, sabe cómo navegar rápidamente por los informes, ver varios informes uno al lado del otro, etc. Cuando es un cliente sin antecedentes técnicos, puede perderse fácilmente.
Aquí nuevamente, los mensajes más detallados son muy útiles que solo una referencia. Tenga en cuenta que aún desea mantener referencias: nada está más mal que un error que es el mismo que encontró hace dos semanas, pero no recuerde su ID.
Como nota, el mismo problema existe en muchas jurisdicciones. En Francia, por ejemplo, no es inusual que una legislación haga referencia a múltiples fuentes, que pueden cambiar mientras tanto. Esto significa que para entenderlo completamente, debe pasar algunas veces horas en una biblioteca, buscando docenas de textos referidos, cada texto con sus propias referencias a otros.
fuente
No hay nada de malo en citar números de problemas en las notas del parche, siempre que los usuarios puedan leer el problema que se cita. Si su base de datos de errores permite que alguien lea, citar el número de error puede ser muy útil. (Una mejor opción, si las notas de su parche están en un formato que permite enlaces, haga que esas ID de problemas sean enlaces al problema en cuestión). Esto no significa que deba exponer todos los problemas al público en general; aún puede ser útil tener unos que estén envueltos (por ejemplo, ¡dónde tienen contraseñas activas!)
Citar un número de problema donde la persona que lee no puede ir y buscar los detalles y el historial del error, eso es bastante hostil. No es que citar tales problemas sin la identificación del problema sea mucho más amigable.
fuente
Obviamente depende de quiénes son las personas que leerán las notas del parche y los usuarios objetivo del software.
Pero en la mayoría de los casos, a la gran mayoría de sus usuarios simplemente no les importa cuál es la identificación del error. No les importa por qué se rompió, cuál es la solución o cualquier otra cosa; solo quieren saber qué cambió con una descripción textual muy sucinta sin tener que ir a otra página para cada cambio.
Citar las ID de errores me hace parar y pensar, y yo, como usuario, no quiero pensar. Es una especie de problema de usabilidad.
Echar un vistazo, por ejemplo, en el registro de cambios de Visual Assist X . Todas esas ID de error vinculadas son solo ruido que me distrae de comprender lo que cambió. Y este es un complemento para un Visual Studio, dirigido a programadores. Y yo soy programador. Si esto me molesta, imagine al usuario promedio que ni siquiera sabe qué es un rastreador de errores ...
PD: fui el autor del comentario que generó la pregunta
fuente
Una identificación de error es obligatoria para un punto de referencia . Las razones:
es más conveniente que:
fuente
Diría que depende de su sistema: tengo suerte de que el que uso detecte automáticamente tales referencias en los mensajes de confirmación y agregue un enlace al ticket almacenado en el rastreador de errores, por lo que no es un problema.
Pero si estuviera en un sistema donde no está disponible, aún mencionaría el ID del ticket (de esa manera, puede buscar rápidamente en los registros por ID del ticket ) junto con una breve descripción de qué es el error.
fuente