Una how-to guide, o guía práctica, es un tipo de documentación que proporciona instrucciones específicas sobre cómo realizar una tarea. Se centra en los aspectos prácticos de un proceso, a menudo con instrucciones paso a paso y ayudas visuales. Las how-to guide están dirigidas a usuarios que desean lograr un objetivo específico y están familiarizados con el producto o módulo.

Esta guía incluye la plantilla disponible, pautas generales y ejemplos de how-to guides.

Asegúrate de revisar las pautas de Mejores prácticas para redactar documentación.

Este tipo de contenido se publica únicamente en inglés.

Aunque tanto los tutoriales como las how-to guides son recursos didácticos, difieren en su estructura y propósito:

Objetivo

Tutorial	Guía práctica
Orientado al aprendizaje. Enseña un concepto, habilidad o proceso de forma detallada.	Orientado a tareas. Se centra en ayudar al usuario a completar una tarea u objetivo específico.

Alcance

Tutorial	Guía práctica
Cubre una serie de pasos o conceptos, normalmente relacionados con el aprendizaje de una nueva habilidad.	Su alcance es limitado, generalmente abarcando una tarea o proceso en etapas.

Contenido

Tutorial	Guía práctica
Educativo, ofrece contexto, antecedentes y explicaciones.	Práctico, con instrucciones directas y orientadas a la acción.

Audiencia

Tutorial	Guía práctica
Orientado a usuarios que desean aprender una habilidad o comprender un concepto en profundidad.	Orientado a usuarios que necesitan alcanzar rápidamente un objetivo específico y ya tienen conocimientos previos.

Tema	Descripción
Título	Como este tipo de guías se escribe únicamente en inglés, debes indicar el objetivo de la misma con un verbo en gerundio. Considera a tu audiencia y la acción que quieres que realicen. Por ejemplo: Setting up your development environment
Antes de comenzar (opcional)	Lista todos los prerrequisitos que el usuario debe cumplir antes de seguir los pasos de la guía, incluyendo: Requisitos de herramientas y software: especifica los requisitos mínimos del sistema, como versiones del sistema operativo, instalaciones de software concretas y configuraciones de hardware. Creación o configuración de la cuenta: si el usuario necesita crear una cuenta o configurar elementos específicos, proporciona instrucciones claras o links a recursos relevantes. Conocimientos o habilidades básicas: si la guía asume cierto nivel de familiaridad con conceptos o herramientas específicos, describe brevemente esos prerrequisitos o proporciona links a recursos de aprendizaje adicionales.
Instrucciones	Proporciona instrucciones detalladas para completar la tarea o lograr el objetivo. Divide el proceso en pasos. Cada paso debe ser claro y accionable. Considera lo que el usuario necesita conseguir al final de la guía y describe cada tarea necesaria para lograrlo. Por ejemplo, si el objetivo es configurar un entorno de desarrollo para crear una tienda física, considera cada tarea que el usuario debe completar para hacerlo. Si una guía requiere solo un paso, omite el Paso 1 - Título del paso, y en la sección Instrucciones, enumera las acciones en una lista ordenada. Cada paso debe guiar al usuario de un punto al siguiente en una secuencia lógica. Cuando corresponda, incluye ejemplos, contenido multimedia o advertencias para ayudar a los usuarios. El último paso debe ilustrar el resultado para que el usuario pueda compararlo con sus resultados.
Contenido de las instrucciones	Cada línea de las instrucciones debe corresponder a un paso que el usuario debe realizar. No asumas conocimientos del usuario. Por ejemplo, si el usuario debe presionar Enter en un paso, incluye esa instrucción como parte del mismo. Utiliza corchetes angulares (>) para desglosar pasos complejos o combinar pasos simples para acciones secuenciales. Por ejemplo: 1. En el Admin VTEX, accede a Storefront > Site Editor. Mantén la coherencia en el tiempo verbal a lo largo de las instrucciones utilizando verbos en imperativo. Por ejemplo: 1. Haz clic en Archivo > Nuevo > Documento.

Plantilla de how-to guide

# Título

[Describe en esta sección el objetivo de la guía y lo que el usuario podrá hacer después de seguirla.]

## Antes de comenzar

[Enumera las herramientas, el software, las cuentas, los conocimientos o las habilidades necesarias que el usuario debe tener antes de comenzar a seguir la guía].

## Instrucciones

### Paso 1 - Título del paso 1

[Proporciona instrucciones para este paso.]

### Paso 2 - Título del paso 2

[Proporciona instrucciones para este paso.]

### Paso 3 - Título del paso 3

[Proporciona instrucciones para este paso.]

• Overriding native component's props
• Managing product images in specific contexts
• Building a search results page with multiple layouts
• Running IO scripts in non-IO VTEX stores