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 se encuentra 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 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]
Propósito
Las notas de la versión son documentos que se comparten con los usuarios finales, los clientes y los clientes de una organización. La definición de los términos 'Usuarios finales', 'Clientes' y 'Clientes' son de naturaleza muy relativa y pueden 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. [4]
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. [5] [6] [7]
También podrían ser incluidos como un artefacto que acompaña a las entregas de Prueba del Sistema y Pruebas de Integración de Sistemas y otros entornos administrados en especial con referencia a una tecnología de la información organizació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 les da 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 contrato de licencia para el usuario final , ya que no contienen (no deben) 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. [8]
Las notas de la versión también se pueden interpretar como una descripción de cómo instalar o compilar el software, en lugar de resaltar nuevas funciones o errores resueltos. [9] Otro término que se utiliza con frecuencia en este contexto es Requisitos del sistema , que significa el hardware y software necesarios para instalar o crear el software.
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 en función de los requisitos y el tipo de información que se va a distribuir. 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 la 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 generalmente son 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 publicació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 las correcciones de errores y las 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 otras funciones se ven afectadas por estos cambios.
- Impactos de soporte : cambios necesarios en el proceso diario de administración del software.
- Notas : notas sobre la instalación de software o hardware , las actualizaciones y la documentación del producto (incluidas las actualizaciones de la documentación)
- Descargos de responsabilidad : mensajes relacionados con la empresa y los productos estándar. p.ej; software gratuito , antipiratería , duplicación, etc. Consulte también el Aviso legal .
- Contacto : información de contacto de soporte.
Una nota de la versión suele ser un breve resumen de los cambios, las mejoras y las 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 se escriben con frecuencia en tiempo presente y proporcionan información clara, correcta y completa.
Existe una propuesta para una especificación abierta y se llama Especificación de esquema de notas de la versión. [10]
Ejemplos destacados (principalmente software)
La siguiente lista es una selección de los principales software de diferentes ramas, como juegos de software, sistemas operativos, automoción, diseño CAD , etc.
- Notas de la versión del proyecto Apache Maven
- Actualizaciones de Apple iOS 14
- Notas de la versión de Apple macOS
- Notas de la versión de Apple Xcode
- Lanzamientos de FreeBSD
- Hitfilm Express de FXhome
- Notas de la versión de GNOME
- Lanzamientos de Gitlab [11]
- Notas de la versión de i.MX Linux® (PDF de NXP Semiconductors )
- Notas de la versión de Atlassian Jira Software
- Linux (Ubuntu)
- Kernel de Linux 5.x
- Notas de la versión de Microsoft Visual Studio
- Registros de cambios de lanzamiento de Minecraft
- Actualizaciones de software de Tesla
- Unity3d 2020.1.0
- Software de Wikipedia MediaWiki
- Windows 10 (consulte también Estado de la versión de Windows )
- Notas de la versión de Xilinx (por ejemplo, Vivado Design Suite )
Ver también
- Registro de cambios
- Gestión de la configuración
- Acuerdo de licencia de usuario final
- README
- Gestión de la liberación
- Release Candidate
- Ciclo de vida de la versión de software
- SWEBOK
- Términos de servicio
Otras lecturas
- Laura Moreno y col. ARENA: Un enfoque para la generación automatizada de notas de la versión , transacciones IEEE sobre ingeniería de software (Volumen: 43, Edición: 2, 1 de febrero de 2017) [12]
- Casey Newton. Bebí cerveza y escribí notas de la versión con el equipo de notas de la versión de Medium, The Verge (2016-02-10) [13]
- Estándares de codificación GNU - 6.8 Cambiar registros
Referencias
- ^ "Cambiar conceptos de registro (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 grandes 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 .
- ^ Hobbs, Brian; Besner, Claude (1 de mayo de 2016). "Proyectos con clientes internos vs 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 .
- ^ "Cambiar registros (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 en los cambios de aplicaciones: un estudio exploratorio sobre registros de cambios de aplicaciones" . Talleres de la 27ª Conferencia Internacional de Ingeniería de Requisitos (REW) del IEEE 2019 : 207–212. doi : 10.1109 / REW.2019.00042 .
- ^ 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, consultado el 25 de marzo de 2021
- ^ release-notes / release-notes-spec , Notas de la versión, 2021-03-25 , recuperado 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 , recuperado 2021-03-25
- ^ "Lanzamientos · GitLab.org / GitLab" . GitLab . Consultado el 13 de febrero de 2021 .
- ^ 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 publicación" . Transacciones IEEE sobre ingeniería de software . 43 (2): 106-127. doi : 10.1109 / TSE.2016.2591536 . ISSN 1939-3520 .
- ^ 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 . Consultado el 5 de abril de 2021 .
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 la 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
- Especificaciones del esquema de las notas de la versión