Diálogo de registro de cambios
Aquí tienes la traducción del archivo fuente de la guía de diseño al español, buscando que suene lo más natural posible:
Tu equipo de servicio puede usar el changelog para informar a los usuarios sobre los cambios.
El changelog se muestra una vez cuando el usuario abre la página del servicio. No proporcionamos una opción para volver a abrir la página del changelog. Implementa esto de forma independiente si es necesario.
Dado que el changelog se muestra en una ventana modal, sigue las reglas para cerrar y escalar ventanas modales.
Elementos
El changelog es una ventana modal de tamaño M con publicaciones organizadas cronológicamente. Cada publicación tiene:
- Fecha de publicación
- Etiqueta New (opcional)
- Encabezado de la publicación
- Imagen de la publicación (opcional)
- Texto de la publicación
- Button de acción (opcional).
Fecha de publicación
A partir de la fecha de publicación, el usuario puede entender cuándo ocurrió un cambio particular en el servicio. Por defecto, la fecha está en formato DD Mon YYYY. También puedes usar otros formatos de fecha para que coincidan con la configuración regional del servicio.
Etiqueta
Usa la etiqueta "New" para las publicaciones nuevas. El servicio determina qué publicaciones considerar nuevas y marcarlas con esta etiqueta. En el texto, puedes usar otras redacciones, diferentes de "New".
Encabezado de la publicación
El encabezado de la publicación se utiliza para una breve descripción del cambio en el servicio. El encabezado puede tener cualquier longitud. No recomendamos:
- Usar encabezados que ocupen más de una línea (contengan más de 70 caracteres), ya que esto empeora la legibilidad del texto.
- Copiar el texto de las noticias al encabezado.
El encabezado utiliza el estilo text-subheader-3. No proporcionamos otros estilos de texto para los encabezados.
Imagen
La imagen es opcional y tiene dimensiones fijas de 516x240px. Puedes usar archivos JPG y PNG como imágenes (los archivos GIF y de video no son compatibles). Usa imágenes cuando necesites ilustrar el tema de la publicación. Se utiliza una imagen tanto para los temas de interfaz claros como oscuros.
Si cargas una imagen de más de 516x240px, se escalará y centrará en el lado más grande.
Considerando las pantallas retina, recomendamos cargar imágenes escaladas el doble en cada lado, es decir, 1032x480px.
Texto de la publicación
El texto de la publicación sigue a la imagen y puede tener cualquier longitud. No recomendamos:
- Usar textos muy largos (más de 500 caracteres). Si no puedes acortar el texto a la longitud recomendada, puedes añadir enlaces a la documentación dentro del texto o proporcionar un botón después del texto para navegar al texto completo.
- Crear subencabezados. Dado que la longitud recomendada del texto es concisa, no necesitas dividir el texto en secciones usando subencabezados.
El texto utiliza el estilo 'text-body-1'. No proporcionamos otros estilos de texto, pero puedes añadir formato, es decir, crear listas con viñetas y numeradas, añadir tachado, subrayado, negrita e cursiva.
Botón de acción
El botón de acción es opcional y se encuentra debajo del texto de la publicación. Úsalo para navegar al texto completo de la publicación.
Solo se admiten botones de tamaño M. El botón puede ser de cualquier tipo, con o sin icono. Cíñete a un solo tipo de botón.
No admitimos varios botones.
Otros elementos
Además, debajo del encabezado de la ventana modal, puedes añadir un enlace "Ver changelog completo" a una página de changelog (esta puede ser una página de servicio separada, un storybook o un servicio de documentación externo).
Recomendaciones de uso
Usa el changelog:
- Cuando necesites informar al usuario sobre cambios significativos en el servicio.
- Cuando necesites mantener al usuario al tanto de cambios menores. En este caso, considera mostrar el changelog periódicamente e informar sobre cualquier cambio menor desde la última entrada del changelog.
- Cuando necesites recordar al usuario sobre los cambios en el servicio y aumentar su conocimiento de lanzamientos anteriores.
No recomendamos:
- Usar el changelog para la incorporación de usuarios.
- Usar el changelog para informar al usuario sobre cada cambio menor en el servicio.