La documentación de las notas release de producto nos referencia las últimas actualizaciones, ajustes, solución a problemas o nuevas funcionalidades de la aplicación.
La descripción correcta de las notas es importante para que el usuario conozca las mejoras, novedades y soluciones de forma estructurada.
Categorías Release
Las notas release por producto organizan la información de las actualizaciones en las siguientes categorías:
| Cartegorías | Descripción |
|---|---|
| Listado de Notas | Esta categoría agrupa el listado de notas de release de cada producto por versión. Las notas descritas dan respuesta a casos reportados en la mesa de servicio (problema, cambios) y deben incluirse como un artículo independiente en la estructura de release de cada producto. |
| Cambios o mejoras implementadas (opcional) | Esta categoría describe los cambios o mejoras del producto. |
| Notas Adicionales (opcional) | Esta categoría agrupa información de interés para el cliente. (ejemplo: Versión base de datos, actualización conserver, compatibilidad con otros productos) |
| Errores Conocidos (opcional) | Esta categoría informativa presenta los errores comunes de la aplicación. |
| Instaladores | Esta categoría incluye el enlace del instalador o instaladores de la versión del producto liberado. Aplica para los productos OnPremise. |
⚐ Nota: La descripción de cada nota debe tener en cuenta el formato sugerido (Ver descripción Notas)
⚐ Nota: Las categorías definidas para organizar los release notes deben mantener el formato definido
Descripción Notas de Release
Cada nota release descrita, de acuerdo al tipo de actualización (Problema, cambio, nueva funcionalidad), debe considerar la siguiente formato para presentar la información de la actualización:
| Características de la Nota | Descripción |
|---|---|
| Título | El nombre de la nota debe relacionar la característica más importante del ajuste (Problema, cambio, actualización). |
| Id del caso | Si la nota hace referencia a un caso reportado en la mesa de servicio, se utiliza la sigla y el número que identifica el caso (Ejemplo: PM (Problema-33496-19-200984). |
| Descripción Tipo Caso | Descripción específica de la nota release de acuerdo al tipo de caso. - Cambio: Si la nota hace referencia a un tipo de caso Cambio, se describe las características de la funcionalidad. - Problema: Si la nota hace referencia a un tipo de caso problema, se describe así: - Antecedentes (Qué pasaba?): Se debe relacionar y describir el antecedente del problema. - Solución (cómo se corrigió): Se debe relacionar y describir las acciones que se tomaron para la mejora. |
| Pantalla (Opcional) | Si el ajuste realizado en la nota, requiere proporcionar mayor claridad al usuario, debe incluir una imagen de ejemplo que evidencie las características del ajuste. |
| Enlace al manual (Opcional) | Si los ajustes mencionados en la nota, son de una nueva funcionalidad o requieren ampliar la información, deben incluir un enlace al manual del producto donde se encuentra docuemntada esta funcionalidad. |