Notas de la versión

Documento que enumera los cambios de software

Las notas de la versión son documentos que se distribuyen con productos de software o productos de hardware, a veces cuando el producto todavía está en estado de desarrollo o prueba (por ejemplo, una versión beta ). ^[1]^[2] Para los productos que ya han sido utilizados por los clientes, la nota de la versión se entrega al cliente cuando se lanza una actualización. Otra abreviatura para las notas de la versión es Registro de cambios o Registros de la versión o Cambios de software o Historial de revisiones Actualizaciones o Archivo README . ^[3] Sin embargo, en algunos casos, las notas de la versión y el registro de cambios se publican por separado. Esta división es para mayor claridad y diferenciación de las características destacadas de los errores, solicitudes de cambio ( CR ) o mejoras en el otro lado. ^[4]^[5]

Objetivo

Las notas de la versión son documentos que se comparten con los usuarios finales, clientes y clientes de una organización. La definición de los términos "usuarios finales", "clientes" y "usuarios" es muy relativa por naturaleza y puede tener diversas interpretaciones según el contexto específico. Por ejemplo, el grupo de control de calidad dentro de una organización de desarrollo de software puede interpretarse como un cliente interno. ^[6]

Contenido

Las notas de la versión detallan las correcciones, cambios o mejoras ( funcionales o no funcionales ) realizadas al servicio o producto que proporciona la empresa. ^[7]^[8]^[9]

También se pueden proporcionar como un artefacto que acompaña a los entregables para pruebas de sistemas y pruebas de integración de sistemas y otros entornos administrados, especialmente con referencia a una organización de tecnología de la información .

Las notas de la versión también pueden contener resultados de pruebas e información sobre el procedimiento de prueba . Este tipo de información brinda a los lectores de las notas de la versión más confianza en la corrección o el cambio realizado; esta información también permite que el implementador del cambio realice pruebas de aceptación rudimentarias .

Se diferencian del contrato de licencia de usuario final en que no contienen (no deberían contener) ningún término legal del producto o servicio de software. El enfoque debe estar en la versión del software en sí, no, por ejemplo, en las condiciones legales. ^[10]

Las notas de la versión también pueden interpretarse como una descripción de cómo instalar o construir el software, en lugar de destacar nuevas características o errores resueltos. ^[11] Otro término que se utiliza a menudo en este contexto es Requisitos del sistema , que significa el hardware y el software necesarios para instalar o construir el software.

Estilo de formato

No existe un formato estándar para las notas de la versión que se siga en las distintas organizaciones. Normalmente, las organizaciones adoptan sus propios estilos de formato en función de los requisitos y el tipo de información que se va a difundir. El contenido de las notas de la versión también varía según el tipo de versión. En el caso de los productos que se encuentran en la etapa de prueba y que se lanzan recientemente, el contenido suele ser más descriptivo en comparación con las notas de la versión para correcciones de errores y mejoras de funciones, que suelen ser breves.

Las notas de la versión pueden incluir las siguientes secciones:

Encabezado : nombre del documento (es decir, notas de la versión), nombre del producto, número de versión, fecha de lanzamiento, fecha de la nota, versión de la nota, etc.
Descripción general : una breve descripción general del producto y los cambios, en ausencia de otra documentación formal.
Propósito : una breve descripción general del propósito de la nota de la versión con una lista de las novedades de esta versión, incluidas correcciones de errores y nuevas características.
- Resumen del problema : una breve descripción del error o la mejora en la versión.
- Pasos para reproducir : Los pasos que se siguieron cuando se encontró el error.
- Resolución : una breve descripción de la modificación/mejora que se realizó para corregir el error.
Impacto en el usuario final : qué acciones diferentes deben realizar los usuarios finales de la aplicación. Esto debería incluir si estos cambios afectan a otras funciones.
Impactos de soporte : Cambios requeridos en el proceso diario de administración del software.
Notas : notas sobre la instalación de software o hardware , actualizaciones y documentación del producto (incluidas las actualizaciones de la documentación)
Descargo de responsabilidad : mensajes relacionados con la empresa y el producto estándar, por ejemplo: software gratuito , antipiratería , duplicación, etc. Consulte también el descargo de responsabilidad .
Contacto - Información de contacto de soporte.

Una nota de lanzamiento suele ser un breve resumen de los cambios, mejoras y correcciones de errores recientes en una versión de software en particular. No sustituye a las guías de usuario . Las notas de lanzamiento suelen estar escritas en tiempo presente y brindan información clara, correcta y completa.

Existe una propuesta para una especificación abierta llamada Especificación de esquema de notas de versión. ^[12]

Véase también

Lectura adicional

Laura Moreno et al. ARENA: Un enfoque para la generación automatizada de notas de lanzamiento , IEEE Transactions on Software Engineering (volumen: 43, número: 2, 1 de febrero de 2017) ^[13]
Newton, Casey (10 de febrero de 2016). "Bebí cerveza y escribí notas de lanzamiento con el equipo de notas de lanzamiento de Medium". The Verge . Vox Media . Consultado el 5 de abril de 2021 .
Estándares de codificación GNU - Registros de cambios 6.8

Referencias

^ "Conceptos del registro de cambios (estándares de codificación GNU)" www.gnu.org . Consultado el 5 de abril de 2021 .
^ Scott, James (24 de abril de 2020). "El arte de escribir excelentes notas de lanzamiento". Medium . Consultado el 5 de abril de 2021 .
^ "Lanzamientos (Estándares de codificación GNU)". www.gnu.org . Consultado el 5 de abril de 2021 .
^ "Historial de versiones - Inglés - Base de conocimientos". kb.i-doit.com . Consultado el 10 de octubre de 2021 .
^ "56508 - Zynq-7000 SoC, 14.6 FSBL - ¿Hay un registro de cambios?". Búsqueda de palabras clave de soporte de Xilinx .
^ Hobbs, Brian; Besner, Claude (1 de mayo de 2016). "Proyectos con clientes internos y externos: una investigación empírica de la variación en la práctica". Revista internacional de gestión de proyectos . 34 (4): 675–687. doi : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863.
^ "Registros de cambios (estándares de codificación GNU)". www.gnu.org . Consultado el 5 de abril de 2021 .
^ Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (septiembre de 2019). "Los ojos de los desarrolladores sobre los cambios en las aplicaciones: un estudio exploratorio sobre los registros de cambios de las aplicaciones". Talleres de la 27.ª Conferencia Internacional de Ingeniería de Requisitos (REW) del IEEE de 2019. págs. 207–212. doi :10.1109/REW.2019.00042. ISBN 978-1-7281-5165-6.S2CID209460408 .
^ Bourne, Kelly C. (1 de enero de 2014), Bourne, Kelly C. (ed.), "Capítulo 10: Actualizaciones y parches", Manual del administrador de aplicaciones , Boston: Morgan Kaufmann, págs. 150-165, doi :10.1016/b978-0-12-398545-3.00010-8, ISBN 978-0-12-398545-3, consultado el 25 de marzo de 2021
^ release-notes/release-notes-spec, Notas de la versión, 2021-03-25 , consultado el 2021-03-25
^ "Linux kernel release 5.x — La documentación del kernel de Linux". www.kernel.org . Consultado el 25 de marzo de 2021 .
^ release-notes/release-notes-spec, Notas de la versión, 2021-03-25 , consultado el 2021-03-25
^ Moreno, L.; Bavota, G.; Penta, MD; Oliveto, R.; Marcus, A.; Canfora, G. (febrero de 2017). "ARENA: un enfoque para la generación automatizada de notas de lanzamiento". IEEE Transactions on Software Engineering . 43 (2): 106–127. doi : 10.1109/TSE.2016.2591536 . ISSN 1939-3520.

Enlaces externos

Cómo escribir notas de lanzamiento
¿Cómo deben redactarse las notas de la versión? (Stackoverflow)
El extraño arte de escribir notas de lanzamiento de aplicaciones
Notas de la versión Hub (también https://www.release-notes.com) de código abierto en GitHub
Notas de la versión: especificación del esquema

[1] "Conceptos del registro de cambios (estándares de codificación GNU)" www.gnu.org . Consultado el 5 de abril de 2021 .

[2] Scott, James (24 de abril de 2020). "El arte de escribir excelentes notas de lanzamiento". Medium . Consultado el 5 de abril de 2021 .

[3] "Lanzamientos (Estándares de codificación GNU)". www.gnu.org . Consultado el 5 de abril de 2021 .

[4] "Historial de versiones - Inglés - Base de conocimientos". kb.i-doit.com . Consultado el 10 de octubre de 2021 .

[5] "56508 - Zynq-7000 SoC, 14.6 FSBL - ¿Hay un registro de cambios?". Búsqueda de palabras clave de soporte de Xilinx .

[6] Hobbs, Brian; Besner, Claude (1 de mayo de 2016). "Proyectos con clientes internos y externos: una investigación empírica de la variación en la práctica". Revista internacional de gestión de proyectos . 34 (4): 675–687. doi : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863.

[7] "Registros de cambios (estándares de codificación GNU)". www.gnu.org . Consultado el 5 de abril de 2021 .

[8] Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (septiembre de 2019). "Los ojos de los desarrolladores sobre los cambios en las aplicaciones: un estudio exploratorio sobre los registros de cambios de las aplicaciones". Talleres de la 27.ª Conferencia Internacional de Ingeniería de Requisitos (REW) del IEEE de 2019. págs. 207–212. doi :10.1109/REW.2019.00042. ISBN 978-1-7281-5165-6.S2CID209460408 .

[9] Bourne, Kelly C. (1 de enero de 2014), Bourne, Kelly C. (ed.), "Capítulo 10: Actualizaciones y parches", Manual del administrador de aplicaciones , Boston: Morgan Kaufmann, págs. 150-165, doi :10.1016/b978-0-12-398545-3.00010-8, ISBN 978-0-12-398545-3, consultado el 25 de marzo de 2021

[10] release-notes/release-notes-spec, Notas de la versión, 2021-03-25 , consultado el 2021-03-25

[11] "Linux kernel release 5.x — La documentación del kernel de Linux". www.kernel.org . Consultado el 25 de marzo de 2021 .

[12] release-notes/release-notes-spec, Notas de la versión, 2021-03-25 , consultado el 2021-03-25

[13] Moreno, L.; Bavota, G.; Penta, MD; Oliveto, R.; Marcus, A.; Canfora, G. (febrero de 2017). "ARENA: un enfoque para la generación automatizada de notas de lanzamiento". IEEE Transactions on Software Engineering . 43 (2): 106–127. doi : 10.1109/TSE.2016.2591536 . ISSN 1939-3520.