¿Qué son las notas de la versión y quién las lee? ¿Deberían/podrían automatizarse simplemente escupiendo correcciones de errores para la versión actual, o merecen una cuidadosa edición humana? Entonces, ¿alguien con un enlace a las mejores prácticas (razonamiento detrás) con respecto a las notas de la versión de software?Notas de la versión, ¿para qué?
notas de la versión también son importantes para su organización de pruebas (si tiene uno), para que sepan lo que ha cambiado en la liberación y necesita pruebas.
Esto realmente depende de para quién se construye su aplicación y los objetivos de su organización. Sin embargo, tiendo a creer que las notas de la versión deben ser una lista concisa de importantes adiciones, mejoras o correcciones clave que se incluyen en la versión en particular.
A veces basta con un simple volcado de la información del sistema de seguimiento de errores, otras veces, creo que deben refinarse.
La clave es que, por lo general, se considera que las Notas de la versión son la lista de cambios tipo "Oye, mira lo que hicimos".
Correcciones de errores y funciones adicionales. Los usuarios los leerán para determinar si deben tomarse la molestia de instalar una actualización incremental, o esperar hasta la próxima versión porque esta no agrega ninguna característica que necesiten ni corrige ningún error en las características que estaban usando.
Yo diría que al menos requieren que un humano las lea y se asegure de que cada nota sea útil. Depende de qué tan buenos sean los comentarios sobre las correcciones de errores.
Nuestras notas de publicación son creadas por el ser humano en lugar de creadas por la máquina. La cubierta tres temas principales.
¿Qué se incluye en las versiones (lista de archivos)
cómo instalarlo
lo que ha cambiado desde la última versión (especialmente si los cambios no están en la manual todavía).
Los artículos 1 y 2 no influyen mucho de una versión a otra, pero deben revisarse. El artículo 3 requiere más trabajo.
Interesante opinión sobre este Jim. Por lo general, veo que los artículos 1 y 2 se incluyen en otra documentación y no en un archivo de notas de la versión ... –
Las notas de la versión y los README pueden ser muy importantes si su cliente tiene que tomar medidas especiales además de los procedimientos normales para poder actualizar. También es útil advertir a los clientes/usuarios de cualquier actualización de db que pueda suceder automáticamente como resultado de la instalación de un parche más reciente. La forma en que lo veo, Release Notes y README debe escribirse para la audiencia del administrador del sistema. Así que incluya los tipos de cosas que desearían conocer: resúmenes de cambios importantes, cómo instalar, errores conocidos, cualquier cosa que haga su software que haga que alguien se quite el pelo, etc.
Normalmente leo notas de la versión . Tiendo a querer una lista exhaustiva completa de cambios en las características (o tan buena como plausible) a fin de potenciar más mi utilización del nuevo producto.
Quiero ver cuándo se resuelven ciertos errores críticos o problemas críticos de seguridad.
Las notas de la versión también son muy importantes en el entorno de producción .
Ayudan a responder a la pregunta histórica:
¿Qué diablos está ejecutando actualmente en producción?
O la pregunta más refinada: ¿este error se ha corregido en esta versión?
Nota de versión depende de su organización.
puedo hablar de mi organización. Utilizamos notas de lanzamiento en formato PDF y cada vez que publicamos un clic o una versión de fondo. Enviamos al gerente de la oficina la nota de la versión. Este es un documento utilizado por el administrador superior del negocio (no solo TI). Este documento es una forma de que ellos sepan qué está pasando. Lo que ha cambiado, las nuevas características que están ahora en producción, los errores corregidos y otras cosas que podrían querer explicar a su usuario.
Este es un documento que puede ser de entre 3 a 4 páginas, que describe el trabajo que se ha hecho en esta versión con breves palabras.
Esto es, por supuesto, depende del tipo de aplicación/servicio/lo que sea altamente,
pero me he dado cuenta que la lectura de las notas de la versión de mi favorito herramientas de desarrollo, etc ..
menudo me hacen tropiezo con agradable, interesante o incluso características que probablemente extrañaría si no al menos las notas ... bueno, tal vez no asesino, pero me entiendes ;-)
Como la mayoría de los usuarios avanzados de la computadora (ahora qué tipo de expresión es que ...)
Nunca me molestó mucho con la documentación ordinaria, así que esto me da
ese algo adicional someth ing, además de hacer clic, flotando y faq'ing ...
notas de la versión son de los probadores y los usuarios saber qué hay de nuevo/cambiado. Además, las notas de la versión se pueden usar como documentación de respaldo cuando se factura una nueva "versión" de un software para el cliente que se está creando para ellos. v1.31 parece mucho más fácil de relacionar y profundizar.
En lugar de compilar las dos listas manualmente, si puede utilizar su comunicado señala que hacer eso para usted es muy bueno.
Lo marco como respuesta porque, en la práctica, no creo que los demás usuarios en general lean las notas. Otros usuarios tienden a leer ayuda, o información sobre herramientas y otros lugares en la aplicación. Sin embargo, QA aprecia notas detalladas de la versión para probar y, al menos en mi organización, realmente las lee. Gracias. –