Asistentes
Menú
Feedback
Guías
Docs
Plantillas
Comunicados
Comunicados

Un comunicado informa a los usuarios sobre nuevas funcionalidades, mejoras, corrección de errores y otras actualizaciones de productos y del sistema. En esta guía encontrarás pautas generales, la plantilla del comunicado y ejemplos.

Consulta también las directrices del artículo Mejores prácticas para la redacción de documentación.

Redactar un comunicado

TemaDescripción
Introducción
  1. Comienza el primer párrafo con una descripción general que explique el cambio y su impacto significativo para retailers o clientes.
  2. Asegúrate de que el lector comprenda de inmediato cómo afectará el comunicado a las operaciones de su tienda.
  3. Menciona la región (por ejemplo, Global, Brasil, LATAM, APAC, EE. UU. o EMEA) y la fase del producto (beta, alfa o disponibilidad general) en el párrafo introductorio.
Títulos de encabezadoAsegúrate de que los títulos y encabezados usen el mismo texto estándar en todas las versiones regionales del contenido.
"¿Qué cambió?"Explica el caso de uso.
"¿Por qué realizamos este cambio?"Explica qué motivó a VTEX a crearlo y haz una lista con viñetas para explicar los problemas de negocio que resuelve.
¿Qué se necesita hacer?
  1. Guía a los usuarios sobre cómo aprovechar estas nuevas funcionalidades lo antes posible.
  2. Incluye una llamada a la acción que los dirija a más información.

Plantilla de comunicados

Plantilla de comunicados

# Nombre de la funcionalidad + beneficio
Creamos/actualizamos la funcionalidad <insertar el beneficio clave> para que puedas <realizar la tarea>. Está disponible en <alfa, beta, un país específico o para todos los usuarios (disponibilidad general)>.
## ¿Qué cambió?
Antes, tenías que <cómo el usuario solía resolver el problema>. Ahora, tienes este <nuevo botón/página> donde puedes <beneficio>.
## ¿Por qué realizamos este cambio?
Para <facilitar tu tarea>, hemos desarrollado <tema>. Está disponible para <usuarios específicos o generales> en <nombre del módulo>. Sus principales ventajas son:
- Beneficio clave 1
- Beneficio clave 2
- Beneficio clave 3
## ¿Qué se necesita hacer?
Para <utilizar este nuevo recurso> debes <instalar algo, ajustar una configuración o ir a un menú.>
Para más información <sobre la funcinalidad/módulo/producto>, consulta <el artículo/tema>.

Accede a ejemplos de artículos de comunicados en el Help Center.

Contribuidores
1
Photo of the contributor
+ 1 contributors
¿Te ha parecido útil?
No
Sugerir cambios (GitHub)
Información general
« Previous
Documentación de aplicaciones
Next »
Contribuidores
1
Photo of the contributor
+ 1 contributors
En esta página
GitHubCommunityFeedback