Plantillas
Resolución de problemas
Resolución de problemas
Los artículos de resolución de problemas ayudan a los usuarios a encontrar soluciones prácticas a los problemas que puedan enfrentar al completar acciones en la plataforma.
Consulta en esta guía las plantillas disponibles, directrices generales y ejemplos de artículos para la resolución de problemas.
Asegúrate de revisar las pautas en Buenas prácticas para la redacción de documentación.
Cómo redactar un artículo de resolución de problemas
| Tema | Descripción |
|---|---|
| Título | Describe claramente el problema de manera concisa y directa, utilizando la primera persona. |
| Introducción | Proporciona una breve descripción del escenario del problema, incluyendo los módulos afectados, los mensajes de error y capturas de pantalla. |
| Soluciones | Describe los pasos para resolver el problema, incluyendo:
|
| Recursos | Incluye capturas de pantalla u otras ayudas visuales para facilitar la comprensión (si corresponde). |
| Perspectiva del usuario | Escribe desde el punto de vista del usuario, centrándote en el problema que está experimentando. |
| Tags y palabras clave del producto | Incluye tags y palabras clave relevantes para el producto para mejorar la visibilidad en las búsquedas. |
| Responsabilidad | Indica quién es responsable de resolver el problema y tomar las medidas necesarias: VTEX, el usuario o ambos. |
| Análisis de la causa raíz | Identifica la causa subyacente del problema para proporcionar soluciones efectivas. |
Plantillas de solución de problemas
Plantilla 1 - Grupos de errores y problemas
# TítuloProduct tags: [Agregar productos relacionados con el problema. Ejemplo: Pedidos y pagos]Keywords: [Palabras que ayudan a identificar el contenido del artículo en una búsqueda. Ejemplo: Pedido no identificado, SKU, etc.][Agrega una breve introducción que describa el problema que el usuario está enfrentando. Siempre que sea posible, limítala a 2 párrafos.]## SoluciónPara entender el significado y la corrección específica de cada mensaje de error, consulta la siguiente tabla:| Tipo o mensaje de error | Significado | Acción requerida || :--- | :--- | :--- || `{Agregar el mensaje de error}` o `Agregar el tipo de error` | [Describe el significado del mensaje o la causa del tipo de error. Ejemplo: Pedido no encontrado en VTEX (ítem eliminado del catálogo o información incorrecta).] | [Guía al usuario con instrucciones claras. Por ejemplo, ofrece un resumen de los pasos, menciona otro artículo relacionado o recomienda ponerte en contacto con el soporte técnico para obtener más ayuda.] |
Plantilla 2 - Artículos generales
# TítuloProduct tags: [Agregar productos relacionados con el problema. Ejemplo: Pedidos y pagos]Keywords: [Palabras que ayudan a identificar el contenido del artículo en una búsqueda. Ejemplo: Pedido no identificado, SKU, etc.][Añade una breve introducción que describa el problema que el usuario está enfrentando. Limita esta sección a 2 párrafos.]## Solución[Describe las posibles soluciones para resolver el error reportado. Cuando la solución requiera varios pasos divídelos en pasos individuales. Para más detalles, consulta la plantilla Plantilla 3 - Artículos generales: más de un paso en la solución]Para solucionar este problema, puedes probar las siguientes opciones:- [Nombre de la solución 1](#nombre-solucion-1): [Describe el escenario de este problema. Ejemplo: "Site Editor no abre."]- [Nombre de la solución 2](#nombre-solucion-2): …### Nombre de la solución 1[Ejemplo de título: "Verificar roles"][Describe qué se debe hacer para resolver el problema y el resultado esperado.]### Nombre de la solución 2...
Plantilla 3 - Artículos generales: más de un paso en la solución
# Título alternativo### Nombre de la solución 1[Ejemplo de título: Configura tu cuenta VTEX][Describe la solución en pasos de diagnóstico. En cada paso, explica las acciones necesarias para resolver el problema y el resultado esperado.]### Paso 1 - Nombre del paso 1...#### Paso 2 - Nombre del paso 2...### Nombre de la solución 2...#### Paso 1 - Nombre del paso 1...#### Paso 2 - Nombre del paso 2...