Buenas prácticas para escribir notas de lanzamiento

12

En el momento de la entrega de cada versión de software, tenemos que escribir una nota de lanzamiento. Por ejemplo, estos son algunos de los términos que agrego cuando escribo una nota de lanzamiento:

  • Fecha de lanzamiento
  • Error resuelto

¿Es eso suficiente o hay algo más?

release CoolProgrammer
fuente
Esto parece un duplicado de programmers.stackexchange.com/questions/66377/…
1
No olvide las características agregadas
Ratchet Freak

Respuestas:

21

Creo que los siguientes darán paso a las buenas prácticas.

// Fecha relacionada

  • Fecha de lanzamiento

// Características relacionadas

  • Características agregadas
  • Destacado eliminado
  • Características modificadas

// relacionado con errores

  • Errores resueltos
  • Errores sin resolver

// Dependencia relacionada

  • Lista de dependencia

// Pruebas relacionadas

  • Resultados de la prueba unitaria
  • Resultados de la prueba de aceptación

// Control de versiones relacionado

  • Nota de etiqueta
  • Número de revisión

También algunas veces vale la pena resaltar cosas que el usuario final puede querer cambiar en sus configuraciones o flujo de trabajo.

La mayoría de los usuarios finales no se preocupan por el resultado de la prueba. Esperan que tenga alta calidad sin importar lo que diga la nota de lanzamiento.

Lo más importante sobre las notas de lanzamiento es tener en cuenta que cada oración adicional pierde otro 10% de los lectores. Por lo tanto, debe priorizar estrictamente lo que sus usuarios actuales necesitan saber sobre el lanzamiento.

Md Mahbubur Rahman
fuente
1
También vale la pena destacar algunas veces las cosas que el usuario final puede querer cambiar en sus configuraciones o flujo de trabajo
jk.
@jk. Sí, tiene usted razón. He editado mi respuesta como tu buen comentario.
Md Mahbubur Rahman
La mayoría de los usuarios finales no se preocupan por el resultado de la prueba. Esperan que tenga alta calidad sin importar lo que diga la nota de lanzamiento.
Henrik
Sin embargo, las notas de la versión de @Henrik pueden ser útiles para otras personas además de los usuarios finales
jk.
5

Lo más importante sobre las notas de lanzamiento es tener en cuenta que cada oración adicional pierde otro 10% de los lectores. Por lo tanto, debe priorizar estrictamente lo que sus usuarios actuales necesitan saber sobre el lanzamiento.

ddyer
fuente
44
cada línea puede perder el 10% de lectores casuales, desinteresados ​​(o flojos). Esos lectores son aquellos para los que sus notas de lanzamiento no están escritas. Los que se preocupan por lo que has hecho los leerán todos y te agradecerán por cada línea relevante; solo debes tener cuidado al incluir la pelusa que realmente necesita ir a la documentación adecuada.
gbjbaanb