Cómo describir adecuadamente una incidencia a un desarrollador

Cómo describir adecuadamente una incidencia a un desarrollador

Uno de los puntos más conflictivos, problemáticos y complicados de una empresa de software es la comunicación entre los departamentos de soporte y de desarrollo. Uno de los puntos clave en esta comunicación son la notificación de incidencias y como éstas son interpretadas y gestionadas.

Para muchos desarrolladores esta es una parte crítica, por lo que debemos prestar una especial atención, cuidado y profesionalidad.

De la buena comunicación de una incidencia depende la calidad del producto, la velocidad de desarrollo y la buena relación entre soporte y desarrollo.

Os pongo unos consejos que nos puede ayudar a que todos los que introducimos incidencias podamos colaborar al éxito global.

El título

  • El título ideal, es claro, conciso y directo. Un buen título debería ser suficiente para que un desarrollador pueda situarse mentalmente en lo que ocurre y donde.
  • Se debe transmitir lo que ocurre y no lo que se cree que ocurre.
  • Debe ayudar a situar al desarrollador en el componente y área de la aplicación donde ocurre la incidencia

Mal título: El programa rompe.

Mal título: Al pulsar el botón de “Facturar” no hace nada, debe ser por estar bloqueada la entidad.

Mal título: El formulario aparece pequeño.

Buen título: En el formulario de facturas de cliente al hacer «click» en el botón «Aceptar» no se cierra el formulario.

La descripción

  • Incluye un resumen, los pasos para reproducir la incidencia, los resultados esperados y lo que ocurre en realidad.
  • Evita usar palabras descriptivas (sale mal, está feo, es pequeño, no me gusta), trata de ser conciso y describir adecuadamente.

Mal: Cuando imprimo, no ocurre nada. La aplicación no funciona.

Bien: Pulso en el botón “Imprimir”, aparece el cuadro de dialogo de impresión, la barra de progreso de impresión no aparece.

  • Debemos de poner claramente lo que sucede:

Mal: Abrimos un fichero.

Bien: Hacemos doble click en el fichero para abrirlo.

Información adicional

En ocasiones, como añadido, puede ser aconsejable una captura con lo que sucede. Puede ayudar al desarrollador a tener una visión global.

Si la incidencia ocurre con unos datos específicos o una aplicación particular. Es muy aconsejable añadir a la incidencia una versión acotada de la aplicación donde sea realmente fácil observar el comportamiento.

Hay que tener en cuenta que es una información adicional, una imagen o unos datos acompañados de un mal título o mala descripción, solo conseguirá liar al desarrollador.

Resumen

  • Intenta escribir la incidencia tan corta como sea posible, esto te ayudará a dejarlo más claro.
  • Relee la incidencia justo antes de enviarla y ponte en la mente de la persona que la leerá.
  • Un buen resumen de la incidencia ayuda a que se solucione antes.
  • Un mal resumen de la incidencia creará un conflicto.
  • No añadas opiniones o creencias, limítate a transmitir lo que ves.
  • Por encima de todo, se preciso. A los desarrolladores les gusta la precisión.

Enlaces de interés

por David Gutiérrez

CTO Visual MS