Hispanopedia WikiLas notas de la versión describen información importante sobre la distribución de un producto de hardware o software . [ 1 ] A menudo, las notas de la versión acompañan una actualización de un producto que se lanzó previamente y está en uso. Pero también pueden estar disponibles para un producto que aún está en desarrollo o en fase de pruebas (por ejemplo, una versión beta ). [ 2 ] [ 3 ] Las notas de la versión se suelen compartir con los usuarios finales, clientes y usuarios de una organización. [ 4 ]
Los nombres alternativos utilizados y la información relacionada incluyen changelog , [ 5 ] [ 6 ] registros de lanzamiento, cambios de software, historial de revisiones, actualizaciones o README . [ 7 ] A menudo, las notas de lanzamiento y el changelog se publican por separado para permitir la diferenciación de las características destacadas de los errores, las solicitudes de cambio y otras mejoras. [ 8 ] [ 9 ] Las notas de lanzamiento difieren del acuerdo de licencia de usuario final , ya que no contienen (ni deberían contener) ningún término legal del producto o servicio de software. El enfoque debe estar en el lanzamiento del software en sí, no, por ejemplo, en las condiciones legales. [ 10 ]
Las notas de la versión pueden proporcionarse como un artefacto que acompaña a los entregables para las pruebas del sistema y las pruebas de integración del sistema , así como para otros entornos gestionados, especialmente en el contexto de una organización de tecnología de la información . Estas notas pueden contener los resultados de las 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 mayor confianza en la corrección o el cambio realizado; además, permite al implementador del cambio realizar pruebas de aceptación básicas .
Las notas de la versión pueden describir cómo instalar o compilar el software, en lugar de destacar nuevas características o errores resueltos. [ 11 ] Otro término que se usa a menudo en este contexto son los requisitos del sistema : el hardware y el software necesarios para instalar, ejecutar o compilar el software.
Contenido
Al no existir estándares, tanto el formato como el contenido varían. Generalmente, las notas de la versión son un resumen conciso de los cambios recientes (no sustituyen a una guía del usuario ), están escritas en presente e incluyen información como:
- Encabezamiento
- 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
- Un breve resumen de los cambios y, a falta de otra documentación, también del producto.
- Objetivo
- Describe el propósito del documento.
- Asuntos
- Una lista de las novedades de esta versión, incluyendo correcciones de errores y nuevas funciones.
- Resumen del problema
- Una breve descripción del error o de la mejora incluida en la versión.
- Pasos para reproducir
- Los pasos que se siguieron cuando se detectó 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? Esto debe incluir si otras funcionalidades se ven afectadas por estos cambios.
- Impactos de apoyo
- Cambios necesarios en el proceso diario de administración del software.
- Notas
- Otra información como la instalación , las actualizaciones y la documentación del producto (incluidas las actualizaciones de la documentación).
- Descargo de responsabilidad
- Mensajes de la empresa y del producto estándar (por ejemplo, un aviso antipiratería , orientación sobre software gratuito u otra información sobre duplicación). Véase también el descargo de responsabilidad .
- Contacto
- Información de contacto para soporte.
La especificación del esquema de notas de lanzamiento es una especificación propuesta para un documento de notas de lanzamiento. [ 12 ]
Véase también
Lecturas adicionales
- 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 . Recuperado el 5 de abril de 2021 .
- Estándares de codificación GNU - Registro de cambios 6.8
Referencias
- ↑ Bourne, Kelly C. (1 de enero de 2014), «Capítulo 10: Actualizaciones y parches» , en Bourne, Kelly C. (ed.), Manual del administrador de aplicaciones , Boston: Morgan Kaufmann, pp. 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
- ↑ "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" . Medium . Recuperado el 5 de abril de 2021 .
- ↑ Hobbs, Brian; Besner, Claude (1 de mayo de 2016). "Proyectos con clientes internos frente a clientes externos: una investigación empírica de la variación en la práctica" . International Journal of Project Management . 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 perspectiva de los desarrolladores sobre los cambios en las aplicaciones: un estudio exploratorio sobre los registros de cambios de las aplicaciones" . 2019 IEEE 27th International Requirements Engineering Conference Workshops (REW) . pp. 207–212 . doi : 10.1109/REW.2019.00042 . ISBN 978-1-7281-5165-6. S2CID 209460408 .
- ↑ "Versiones (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 por palabras clave de soporte de Xilinx .
- ↑ release-notes/release-notes-spec , Notas de la versión, 2021-03-25 , consultado el 2021-03-25
- ↑ "Versión 5.x del kernel de Linux — 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. Bibcode : 2017ITSEn..43..106M . doi : 10.1109/TSE.2016.2591536 . ISSN 1939-3520 .
Enlaces externos
- Cómo escribir notas de lanzamiento
- ¿Cómo se deben redactar las notas de la versión? (Stack Overflow)
- 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 ) código abierto en GitHub
- Notas de la versión Especificación del esquema
- Comunicación técnica
- Lanzamiento de software
- Gestión de la configuración
- Gestión del cambio
