Las guías de inicio rápido permiten a los usuarios completar rápidamente una tarea concreta, ya que ilustran un flujo de trabajo con solo los pasos esenciales, en unos cinco minutos o 600 palabras. Las guías de inicio rápido se pueden usar para configurar una nueva herramienta o realizar otra tarea rápidamente. Para tareas más complejas, usa un tutorial.
Los inicios rápidos son útiles para usuarios que ya entienden la característica o el producto y están listos para probarlos.
En conjunto, nos referimos a los tutoriales y guías de inicio rápido como "guías" en el sitio. En las páginas de aterrizaje de /guides, se incluyen tutoriales, guías de inicio rápido y determinados artículos de procedimientos en la lista de guías de un conjunto de documentos.
Cómo escribir una guía de inicio rápido
Para obtener la plantilla de inicio rápido, consulte "Plantillas".
Contenido de las guías de inicio rápido:
- Introducción:
- Resalta que esta guía es rápida y específica con expresiones como:
- Quickly add [CARACTERÍSTICA] to your project
- The essentials for getting started with [PRODUCTO]
- An abbreviated guide for people who are familiar with [CARACTERÍSTICA]
- Deja clara la audiencia.
- Indica claramente los requisitos y conocimientos previos necesarios.
- Indica lo que el usuario logrará o creará.
- Resalta que esta guía es rápida y específica con expresiones como:
- Secciones de procedimientos
- En función de la audiencia de la guía de inicio rápido, los pasos pueden ser menos explícitos y formales que los que se usan en el contenido de procedimientos. No es necesario usar contenido reutilizable para elaborar estos pasos si la audiencia no requiere ese nivel de detalle.
- Incluye vínculos a otros artículos o recursos en lugar de replicarlos, para no interrumpir el flujo de información.
- Proporciona indicaciones visuales. Usa bastantes bloques de código y capturas de pantalla para asegurarte de que los usuarios realizan las acciones correctas.
- Solución de problemas (opcional)
- Si hay contenido de solución de problemas relevante para la guía de inicio rápido, proporciona vínculos a él.
- Pasos siguientes
- Proporciona un resumen rápido de lo que se ha logrado en la guía de inicio rápido antes de continuar con los pasos siguientes.
- Incluye 2 o 3 pasos siguientes que el usuario puede realizar después de completar la guía de inicio rápido. Incluye siempre vínculos al contenido conceptual de la característica o el producto. También puedes incluir vínculos a otra información relacionada de docs.github.com o GitHub Skills.
Directrices para el título de las guías de inicio rápido
- Cuando la guía ayuda a alguien a empezar a trabajar con una nueva herramienta, pon "Quickstart" al principio del título; por ejemplo, "Quickstart for GitHub Actions" o "Quickstart: Procedural title".
- Para otros casos de uso, sigue las directrices para los títulos de los procedimientos y omite la palabra "Quickstart".