Cuándo usarla

Publica notas de versión con cada versión que lances, ya sea un lanzamiento mayor o un pequeño parche. Los usuarios y administradores las leen para decidir cuándo actualizar, y los equipos de soporte las leen para responder preguntas después. Una copia en PDF es útil para clientes que necesitan documentación de versión para auditorías, aprobación de cambios o un archivo sin conexión.

Qué incluye

• Un título con un campo por completar para tu proyecto, seguido del número de versión y la fecha de publicación.
• Aspectos destacados, y luego listas separadas de añadido, mejorado y corregido en el orden habitual de un registro de cambios.
• Notas de actualización numeradas, una sección de problemas conocidos y una línea de comentarios con un campo por completar para tu correo.

Consejos para un mejor documento

• Describe las correcciones por el comportamiento que verán ahora los usuarios, no por la causa interna. Les importa que las exportaciones ya no fallen, no qué función se corrigió.
• Pon cualquier cosa que requiera acción, como una copia de seguridad o un cambio de configuración, en las notas de actualización y menciónala también en los aspectos destacados. El estilo Técnico mantiene fáciles de leer los números de versión y los comandos.