La documentación de VTEX está diseñada para proporcionar información clara y concisa a cualquier persona interesada en usar o integrar nuestros productos. Nuestro objetivo es empoderar a clientes y partners mediante recursos que faciliten el aprendizaje sobre la plataforma y el desarrollo de su negocio.

Consulta en esta guía cómo VTEX crea la documentación y cómo puedes contribuir.

VTEX pone a tu disposición recursos tales como guías, tutoriales, rutas de aprendizaje y actualizaciones de producto, así como espacios para hacer preguntas y colaborar con la comunidad para resolver dudas sobre los productos VTEX:

Nombre del portal	Descripción
Help Center	Ofrece tutoriales para principiantes, guías de referencia y artículos.
Developer Portal	Proporciona información sobre integraciones, API y recursos de desarrollo para tu tienda.
Community	Permite conectarte con otros usuarios, hacer preguntas y compartir conocimientos dentro del ecosistema VTEX.
Learning VTEX	Proporciona un entorno de aprendizaje para desarrollar una tienda usando Store Framework o una Aplicación VTEX.

En VTEX, nuestro objetivo al redactar documentación es hacer que todo sea lo más simple y claro posible para los usuarios que trabajan con soluciones VTEX o que están interesados ​​en ellas.

Agradecemos las contribuciones a la documentación de VTEX y te invitamos a participar en la mejora continua de la experiencia de uso. Existen distintas maneras de colaborar, dependiendo del portal de documentación que te interese y del método que prefieras. Consulta nuestras Directrices de contribución para más información.

Antes de empezar a escribir, es importante comprender a tu audiencia y los objetivos específicos de la documentación. Para ayudarte a definir estos objetivos responde a las siguientes preguntas:

• ¿Qué quieres que logren los usuarios después de leer tu documentación?
• ¿Cuáles son las tareas o conceptos esenciales que necesitan comprender?
• ¿Qué información adicional podría mejorar la comprensión del usuario?

Para ayudarte a definir la audiencia, responde a las siguientes preguntas:

• ¿A quién va dirigida esta información?
• ¿Qué desean conseguir?

En VTEX identificamos los siguientes tipos de audiencia para nuestra documentación:

Tipo de audiencia	Descripción
Principiante	Son nuevos en el ámbito del ecommerce y en VTEX, con poca o ninguna experiencia previa. Su principal reto es adaptarse a la plataforma y al contexto del ecommerce.
Operativa	Gestiona las tareas diarias relacionadas con una tienda online, como registrar SKUs y gestionar promociones. Está familiarizada con el entorno del ecommerce, pero puede encontrarse con problemas que no pueda resolver por sí mismo.
Altamente técnica	Desarrolla o integra soluciones técnicas con VTEX. Trabaja en implementaciones para tiendas, desarrollo de aplicaciones con nuestras soluciones e integraciones con sistemas de partners vía APIs VTEX. Esta audiencia requiere documentación técnica detallada que describa las características de todas nuestras funcionalidades e indique cómo satisfacer las necesidades del negocio.

Para definir el contexto de la documentación, utiliza la siguiente lista:

Audiencia

• Principiante
• Operativa
• Altamente técnica

Categoría de aprendizaje

• Conocimiento: la audiencia puede describir o parafrasear un concepto o característica.
• Comprensión: la audiencia puede comprender un concepto para apoyar la toma de decisiones.
• Aplicación práctica: la audiencia puede seguir instrucciones para completar una tarea.

Objetivo de aprendizaje

1. Elige una o dos tareas o conceptos que se abordarán en el contenido. ¿Qué debería poder hacer o comprender una persona después de leer este artículo?
2. Ejemplo de plantilla: "Crea una guía sobre {agregar el propósito de la guía}. La guía debe destacar la claridad, la estructura y la facilidad de uso. Está dirigida a {agregar audiencia de la guía}."

Estas directrices reflejan la forma en que VTEX entiende y aplica las normas de estilo al crear contenido funcional y técnico sobre nuestra plataforma.

Principio	Orientación	Uso
Claridad y concisión	Usa un lenguaje simple y evita la jerga técnica. Divide los conceptos complejos en pasos más pequeños y fáciles de entender. Utiliza encabezados y subtítulos claros e informativos para guiar a las personas lectoras a lo largo de la documentación.	En lugar de escribir Utiliza el endpoint de la API para la creación de productos, escribe Crea un nuevo producto usando la API. Utiliza encabezados como Primeros pasos, Instrucciones y Funciones avanzadas.
Consistencia	Mantén la consistencia en la terminología, el estilo y el formato en toda la documentación.	Usa la misma terminología para conceptos similares que se refieran al mismo tema o audiencia, de forma coherente desde el principio hasta el final del texto (ejemplo: cliente en lugar de usuario, y, si la documentación está dirigida a un seller, conserva siempre el sujeto tú en lugar de alternar con seller).
Exhaustividad	Asegúrate de que la documentación sea completa y a la vez concisa, cubriendo todos los temas relevantes con el nivel de detalle necesario.	Si estás documentando una funcionalidad, incluye información sobre cómo usarla, casos de uso comunes y posibles pasos de solución de problemas.
Usabilidad	Ten en cuenta la perspectiva del usuario y redacta la documentación de forma que sea fácil de navegar y usar.	Utiliza títulos, subtítulos y viñetas (bullet points) claros para organizar el contenido.
Flujo lógico	Organiza el contenido en una secuencia lógica y fácil de seguir.	Comienza con una introducción, seguida de secciones detalladas sobre temas específicos.
Ejemplos de multimedia y código	Utiliza recursos multimedia como diagramas, capturas de pantalla y ejemplos de código para facilitar la comprensión.	Usa capturas de pantalla, diagramas y fragmentos de código para ilustrar los ejemplos y garantizar la precisión. Consejo: los diagramas (como los de arquitectura de la plataforma o del producto) pueden ayudarte a representar procesos o relaciones complejas de forma más visual y comprensible.

Para más detalles sobre estos principios, consulta las secciones Grammar y Formatting.