Cambios en el software de listado de documentos
Las notas de la versión son documentos que se distribuyen con productos de software o productos de hardware, a veces cuando el producto aún está en estado de desarrollo o prueba (por ejemplo, una versión beta ). [1] [2] Para productos que ya han sido utilizados por los clientes, la nota de la versión se entrega al cliente cuando se publica una actualización. Otra abreviatura de Notas de la versión es Registro de cambios o Registros de versiones o Cambios de software o Actualizaciones del historial de revisiones 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 características destacadas de 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 "Clientes" es de naturaleza muy relativa y puede tener varias interpretaciones según el contexto específico. Por ejemplo, el grupo de Garantía 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 ofrece la empresa. [7] [8] [9]
También podrían proporcionarse 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 la nota de la versión más confianza en la corrección/cambio realizado; Esta información también permite al implementador del cambio realizar pruebas de aceptación rudimentarias .
Se diferencian del acuerdo de licencia de usuario final en que no contienen (no deberían) contener ningún término legal del producto o servicio de software. La atención debe centrarse 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 compilar el software, en lugar de resaltar nuevas funciones o errores resueltos. [11] Otro término que se utiliza a menudo en este contexto es Requisitos del sistema , es decir, el hardware y el software necesarios para instalar o crear el software.
Estilo de formato
No existe un formato estándar para las notas de la versión que se siga en las diferentes organizaciones. Las organizaciones normalmente adoptan sus propios estilos de formato según los requisitos y el tipo de información que debe circular. El contenido de las notas de la versión también varía según el tipo de versión. Para los productos que se encuentran en etapa de prueba y que se lanzaron 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 publicación, 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 funciones.
- 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é diferentes acciones necesitan los usuarios finales de la aplicación. Esto debe incluir si estos cambios afectan otras funciones.
- Impactos en el 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. p.ej; software gratuito , antipiratería , duplicación, etc. Véase también el descargo de responsabilidad .
- Contacto : información de contacto de soporte.
Una nota de versión suele ser un resumen conciso 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 la versión suelen escribirse en tiempo presente y proporcionan información clara, correcta y completa.
Existe una propuesta para una especificación abierta y se denomina Especificación de esquema de notas de la versión. [12]
Ver también
Otras lecturas
- Laura Moreno et al. ARENA: Un enfoque para la generación automatizada de notas de versión , 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 la versión con el equipo de notas de la versión de Medium". El borde . Medios Vox . Consultado el 5 de abril de 2021 .
- Estándares de codificación GNU - 6.8 Registros de cambios
Referencias
- ^ "Conceptos de 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". Medio . 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 - SoC Zynq-7000, 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 versus 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). "La mirada de los desarrolladores sobre los cambios de las aplicaciones: un estudio exploratorio sobre los registros de cambios de las aplicaciones". 2019 IEEE 27.° Talleres de la Conferencia Internacional de Ingeniería de Requisitos (REW). págs. 207–212. doi :10.1109/REW.2019.00042. ISBN 978-1-7281-5165-6. S2CID 209460408.
- ^ Bourne, Kelly C. (1 de enero de 2014), Bourne, Kelly C. (ed.), "Capítulo 10: Actualizaciones y parches", Manual de administradores 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, recuperado el 25 de marzo de 2021
- ^ notas de la versión/notas de la versión-spec, Notas de la versión, 25 de marzo de 2021 , consultado el 25 de marzo de 2021
- ^ "Lanzamiento 5.x del kernel de Linux: documentación del kernel de Linux". www.kernel.org . Consultado el 25 de marzo de 2021 .
- ^ notas de la versión/notas de la versión-spec, Notas de la versión, 25 de marzo de 2021 , consultado el 25 de marzo de 2021
- ^ Moreno, L.; Bavota, G.; Penta, MD; Oliveto, R.; Marco, A.; Canfora, G. (febrero de 2017). "ARENA: Un enfoque para la generación automatizada de notas de versión". Transacciones IEEE sobre ingeniería de software . 43 (2): 106-127. doi : 10.1109/TSE.2016.2591536 . ISSN 1939-3520.
enlaces externos
- Cómo escribir notas de la versión
- ¿Cómo se deben escribir las notas de la versión? (Desbordamiento de pila)
- Notas de versión de la aplicación El extraño arte de escribir
- Release Notes Hub (también https://www.release-notes.com) de código abierto en GitHub
- Especificación del esquema de notas de la versión