Plantillas
Onboarding
Onboarding
Los artículos de onboarding presentan a los nuevos usuarios una tecnología, herramienta o sistema específico, acelerando su aprendizaje y permitiéndoles ser más competentes y productivos.
Esta guía incluye la plantilla de onboarding, pautas generales y ejemplos de artículos dentro de la categoría.
Este tipo de contenido se publica únicamente en inglés.
Asegúrate de revisar las pautas de las Mejores prácticas para redactar documentación.
Cómo redactar un artículo de onboarding
| Tema | Descripción |
|---|---|
| Enfoque en aspectos fundamentales | Destaca los elementos esenciales que el usuario debe comprender para empezar, como las dependencias críticas, las configuraciones iniciales y los pasos clave de instalación. Evita incluir configuraciones avanzadas, salvo que sean necesarias para el uso inicial. |
| Recursos visuales | Siempre que sea posible, incluye elementos visuales como diagramas, capturas de pantalla o flujogramas, pues ayudan a aclarar procesos complejos y ofrecen a los usuarios una referencia rápida. En la sección de arquitectura, un diagrama bien rotulado facilita la comprensión de los componentes e interacciones del sistema. |
| Instrucciones | En secciones como Inicio rápido, asegúrate de que cada paso sea claro y accionable, y agrega links a recursos adicionales si se necesita una comprensión más profunda. |
| Links a prerrequisitos y aprendizaje adicional | Utiliza links para redirigir a los usuarios a tecnologías, documentación y guías relacionadas. Por ejemplo, en la sección Próximos pasos, sugiere configuraciones o personalizaciones relacionadas e incluye links a recursos que amplíen o complementen el contenido básico de onboarding. |
Plantilla de onboarding
Plantilla de onboarding
# Título[Indica la tecnología en esta sección.]Ej.: Para trabajar con {nombre de la tecnología}, primero debes familiarizarte con las siguientes tecnologías:[Agrega aquí las tecnologías que el usuario debe conocer antes de comenzar a trabajar con la tecnología que se está introduciendo.][Tecnología 1](#)[Tecnología 2](#)[Tecnología 3](#)…## Arquitectura de {nombre de la tecnología}[Agrega un diagrama que muestre la arquitectura de la tecnología y proporciona una explicación clara.]## Inicio rápido (quickstart)[Proporciona instrucciones paso a paso para desarrollar un proyecto usando la tecnología, desde la instalación de los requisitos hasta la ejecución local del proyecto. Ajusta los pasos según la tecnología.]### 1. Configuración inicial[Especifica los requisitos y la configuración inicial necesarios antes de comenzar el proyecto.]### 2. Configuración del proyecto[Indica cómo preparar el entorno de desarrollo y ejecutar el proyecto de manera local.]### 3. Personalización del storefront[Después de ejecutar el proyecto localmente, describe las opciones disponibles para personalizar el storefront.]## Próximos pasos[Sugiere configuraciones adicionales o pasos a seguir tras completar el inicio rápido, e incluye el componente de tarjeta con links a las recomendaciones.]