Guías Prácticas: Estructura, Pasos y Esquema
Construye una guía práctica que convierta el objetivo del lector en pasos ordenados y verificables, con requisitos previos, señales de éxito, rutas de recuperación y solución de problemas.
Una guía práctica es un procedimiento ordenado que lleva al lector desde un estado inicial conocido hasta un resultado verificado. Responde a la pregunta «¿Cómo completo esta tarea?» sin dejar que el lector tenga que inventar un paso faltante.
Cada paso necesita un título imperativo, su razón, la acción, un estado de éxito observable y una ruta de recuperación. Las instrucciones de solo clics funcionan únicamente cuando la cuenta, el acceso, los datos y la interfaz del lector coinciden casualmente con las suposiciones del autor.
Pregunta del lector resuelta: «¿Qué necesito, qué hago en orden, cómo sabré que funcionó y cómo me recupero si no funcionó?»
Preguntas que responde
Una guía práctica sirve a la intención informativa , lo que significa que el lector intenta aprender o completar una tarea en lugar de evaluar una lista de productos. La consulta suele comenzar con «cómo», pero la redacción por sí sola no es suficiente. El resultado previsto debe ser algo que el lector pueda realizar y verificar.
Escribe para las preguntas que las personas realmente llevan al procedimiento:
- «¿Tengo el plan, acceso, herramientas y tiempo requeridos?»
- «¿Qué acciones deben ocurrir en orden y qué debería aparecer después de cada una?»
- «¿Podría esto sobrescribir, publicar, cobrar, eliminar o exponer algo?»
- «¿Cómo me recupero de un resultado diferente y confirmo que la tarea completa funcionó?»
La respuesta directa debe indicar el resultado, la condición inicial, el tiempo esperado y la dificultad antes de la primera explicación extensa. «En unos 20 minutos, un administrador de cuenta puede conectar Search Console y verificar la primera importación exitosa» es útil. «Esta guía explora las mejores prácticas de integración» no lo es.
Cuándo usar este tipo de publicación
Los procedimientos fallan en los límites de las suposiciones. El autor sabe qué acceso, demora o ajuste importa; el lector no. Este formato hace visibles en secuencia las dependencias ocultas, los cambios de estado y las decisiones de recuperación.
| Tipo confundible | Elígelo cuando el lector comienza con | Forma de la respuesta | Por qué no es este tipo |
|---|---|---|---|
| Guía práctica | Un objetivo: «Necesito completar X» | Requisitos previos, pasos ordenados, señales de éxito, recuperación, verificación final | Es el procedimiento en sí. |
| Cómo elegir X | Una decisión: «¿Qué X me conviene?» | Criterios, alternativas, compensaciones, recomendación | «Elegir» describe evaluación, no una secuencia de acciones con un resultado comprobable. |
| Artículo de solución de problemas | Un síntoma: «X falló» o «Veo el error Y» | Árbol de diagnóstico desde el síntoma hasta la causa y la solución | Comienza después de que un procedimiento intentado ya ha producido un problema. |
| Artículo de documentación | Una necesidad de consultar comportamiento, campos, límites o sintaxis | Referencia organizada para consulta en lugar de una ruta de lectura única | Respalda muchas tareas y no promete una ruta narrativa única hacia un resultado. |
Elige una guía práctica solo cuando el orden importe. Si se pueden realizar comprobaciones independientes en cualquier secuencia, publica una lista de verificación. Si el tema es lo suficientemente amplio como para contener varios objetivos distintos, usa una guía definitiva como mapa y crea guías prácticas separadas para los procedimientos. Si el lector pregunta principalmente qué significa un concepto, usa una página qué-es-X .
Ideal para estos tipos de negocio
La clasificación refleja la frecuencia con la que el modelo depende de que un lector complete un proceso repetible, no el valor general del contenido para el negocio.
- SaaS . La configuración, instalación, migración y flujos de trabajo recurrentes determinan si los usuarios alcanzan el valor. Distingue límites de planes, roles, estados de interfaz y cambios destructivos.
- Comercio electrónico . Los compradores necesitan procedimientos de ensamblaje, tallas, instalación, uso y cuidado. Muestra la orientación física cuando las palabras no pueden hacerlo de forma segura.
- Servicio local . Las guías de preparación ayudan a los clientes a recopilar información y comprender las citas. Separa el trabajo seguro del cliente del trabajo reservado a un profesional calificado.
- Marketplaces . Vendedores, compradores, proveedores y administradores pueden seguir diferentes flujos de trabajo. Indica la audiencia y el rol antes de los requisitos previos.
- Servicios B2B . Las guías de incorporación, aprobación, transferencia y revisión aclaran la propiedad y muestran cómo es el trabajo completado.
- Editores de medios y afiliados . Los tutoriales de expertos pueden atender la demanda basada en tareas, pero los editores deben probar el procedimiento y mantener las capturas en lugar de reescribir la documentación del proveedor.
Intención de búsqueda
La intención de búsqueda es el resultado que una persona espera de una consulta. Para la intención procedimental, la forma esperada de la respuesta es una verificación inmediata de viabilidad seguida de una ruta ejecutable: resultado, tiempo, dificultad, requisitos previos, acciones ordenadas, verificación, solución de problemas y siguiente paso.
Los resultados de tareas pueden combinar videos, extractos de pasos, documentación de productos, respuestas de la comunidad y tutoriales. Las respuestas de IA a menudo comprimen la ruta en una secuencia numerada con fuentes. Cada paso extraído debe conservar su objeto, condición y resultado esperado; las advertencias deben ir antes de las acciones riesgosas.
Captura ambos ejemplos en la misma fecha y registra la consulta, ubicación, dispositivo, estado de inicio de sesión e interfaz. Los resultados cambian; la lección de diseño debe provenir de la forma de la respuesta, no de una afirmación de que un proveedor siempre muestra una característica particular.
Estructura de la página
Los rangos de palabras controlan el énfasis, no las cuotas. Añade palabras solo cuando eliminen una decisión que el lector tendría que tomar por sí solo.
| Sección | Rango de palabras | Propósito | Estado |
|---|---|---|---|
| Hero y respuesta directa | 60–100 | Nombra el resultado, el lector, el estado inicial, el tiempo y la dificultad. | Requerido |
| Requisitos previos | 120–220 | Enumera acceso, herramientas, insumos, costos, versiones, condiciones de seguridad y compromisos irreversibles antes de comenzar el trabajo. | Requerido |
| Resumen rápido | 60–120 | Previsualiza las fases principales y el estado final de éxito sin duplicar cada instrucción. | Requerido |
| Procedimiento ordenado | 700–1,500 | Lleva al lector a través de pasos imperativos, razonados, comprobables y recuperables. | Requerido |
| Verificación final | 100–180 | Verifica el resultado final con evidencia observable y enumera lo que incluye «completado». | Requerido |
| Solución de problemas | 250–500 | Resuelve fallos comunes de este procedimiento por síntoma, causa probable y siguiente acción. | Requerido |
| Variaciones | 150–350 | Explica diferencias significativas de plan, dispositivo, rol o versión. | Condicional |
| FAQ | 200–350 | Responde preguntas residuales que no pertenecen dentro de un paso. | Requerido; 5–7 preguntas |
| CTA | 40–90 | Ofrece una acción lógica después de que el lector haya completado o evaluado la tarea. | Requerido |
Elementos requeridos
La lista de pasos es la dueña del contrato del procedimiento. Los requisitos previos protegen su estado inicial y la verificación final prueba el resultado prometido; ninguno tiene una página de elemento separada, por lo que siguen siendo secciones estructurales con nombre en lugar de elementos inventados.
| Elemento | Estado | Posición exacta | Por qué pertenece allí |
|---|---|---|---|
| lista de pasos | Siempre | Después de los requisitos previos y el resumen rápido | La secuencia es el entregable central de la página; cada paso contiene razón, acción, éxito y recuperación. |
| Captura de pantalla anotada | Condicional | Inmediatamente después de la instrucción cuya interfaz o estado es ambiguo | Una captura resuelve la ambigüedad espacial solo mientras permanezca adyacente a la acción relevante. |
| Cuadro de consejo | Condicional | Después de la instrucción requerida que mejora | Una optimización opcional no debe confundirse con una condición de éxito. |
| Cuadro de advertencia | Condicional, obligatorio cuando existe riesgo | Antes de la acción riesgosa o irreversible | Una advertencia puede cambiar el comportamiento solo antes de que se desencadene la consecuencia. |
| Estructura de FAQ | Siempre | Después de la solución de problemas, antes del CTA | Las preguntas residuales pertenecen después del procedimiento completo para que las respuestas no fragmenten la secuencia. |
| Bloque de CTA | Siempre | Bloque de contenido final | La siguiente acción se vuelve razonable solo después de que la página ha entregado el resultado prometido. |
Cuándo son obligatorias las capturas de pantalla
Una captura de pantalla es obligatoria cuando el texto no puede identificar de forma fiable el control, ubicación, estado, orientación o resultado correcto. Úsala para controles similares, configuraciones ocultas, estados visuales sin etiquetar o partes físicas que podrían confundirse. Recorta el área de decisión, conserva el contexto de orientación, marca el objetivo y explícalo en texto.
Una captura de pantalla es ruido cuando repite «Selecciona Guardar», muestra una pantalla completa para un control obvio o reemplaza texto. Nunca hagas que una imagen sea la única fuente de un comando, advertencia, valor o criterio de éxito.
Frontmatter
El frontmatter debe describir el procedimiento con la misma precisión que la página visible.
| Campo | Valor requerido o regla |
|---|---|
entity | Un valor estable verbo–objeto para la tarea, como connect-google-search-console, no el tema amplio search-console. |
schemaType | HowTo cuando la página visible es un procedimiento ordenado con un resultado; de lo contrario Article. |
name | El mismo nombre de tarea que los lectores ven en el título o la respuesta directa. |
description | Resultado y alcance concisos, no una lista de palabras clave. |
totalTime | Duración honesta en ISO 8601 derivada del tiempo de finalización probado; separa el tiempo de espera en el texto visible. |
estimatedCost | Inclúyelo solo cuando el procedimiento requiera una compra o tarifa, usando el monto y la moneda visibles. |
supply y tool | Enumera solo los elementos mencionados en los requisitos previos visibles. No llames suministro físico al acceso de software. |
step | Misma cantidad, orden, nombres, texto, URL e imágenes que los pasos visibles. |
inLanguage y fechas | Coincide con el idioma publicado y el registro de publicación o modificación visible. |
| FAQ | Usa 5–7 preguntas residuales reales en [[faq]]; cualquier acordeón visible y dato estructurado deben coincidir exactamente con ellas. |
El marcado de esquema
son datos legibles por máquina sobre el contenido visible. Publica HowTo como JSON-LD
solo cuando la implementación sea fiel. Nunca marques un requisito previo como un paso, fusiones pasos visibles, añadas instrucciones ocultas o adjuntes la imagen incorrecta. Usa Article cuando no se pueda mantener una correspondencia exacta.
Ejemplo completo
Este esqueleto listo para copiar y pegar utiliza una tarea real. Los indicadores de producción entre corchetes especifican la evidencia que un escritor debe insertar.
# Cómo conectar Google Search Console a Northstar Analytics
Conecta una propiedad verificada de Search Console a Northstar Analytics para que se pueda importar su primer informe de consultas. Un administrador de cuenta puede completar la configuración en unos 15 minutos; la importación puede tardar hasta 30 minutos adicionales. Dificultad: principiante.
## Antes de comenzar
- Una cuenta de Northstar Analytics con el rol de Administrador
- Acceso de propietario a la propiedad de Search Console que vas a conectar
- La propiedad HTTPS exacta que coincida con el host canónico del sitio
- Permiso para compartir datos de rendimiento de Search Console con Northstar Analytics
No continúes con una propiedad de prueba o un host diferente. La conexión puede tener éxito técnicamente mientras importa datos para el sitio equivocado.
## Resumen rápido
Seleccionarás el sitio, autorizarás el acceso, elegirás la propiedad coincidente, iniciarás la importación y verificarás que aparezca una fila de consulta con fecha en Northstar Analytics.
## 1. Confirma que el sitio y la propiedad coincidan
**Por qué existe este paso:** Search Console puede contener propiedades de dominio y prefijo de URL con nombres similares. Elegir la incorrecta produce una conexión válida con datos irrelevantes o incompletos.
**Haz esto:** En Northstar Analytics, abre la página de Configuración del sitio y copia su host canónico. En Search Console, confirma que la propiedad prevista incluya ese host y protocolo.
**Cuándo funcionó:** El host mostrado en ambos productos coincide exactamente, incluyendo `www` y HTTPS.
**Si no funcionó:** Pregunta al propietario de la propiedad cuál representa el entorno de producción. No adivines por su nombre mostrado.
## 2. Inicia la conexión de Search Console
**Por qué existe este paso:** Comenzar desde el sitio seleccionado vincula la autorización al espacio de trabajo correcto de Northstar Analytics.
**Haz esto:** Abre **Configuración → Integraciones → Google Search Console**, luego selecciona **Conectar**.
**Cuándo funcionó:** Una ventana de autorización de Google nombra a Northstar Analytics y te pide que elijas una cuenta.
**Si no funcionó:** Permite ventanas emergentes y vuelve a intentarlo. Si Conectar está deshabilitado, confirma tu rol de Administrador.
[Inserta una captura recortada y anotada del panel de Integraciones solo cuando Conectar sea difícil de distinguir de otro control.]
## 3. Autoriza la cuenta de Google correcta
**Por qué existe este paso:** Northstar puede listar solo las propiedades a las que la cuenta de Google autorizada tiene acceso.
**Haz esto:** Elige la cuenta de Google que sea propietaria de la propiedad prevista, revisa el acceso solicitado y aprueba.
**Cuándo funcionó:** Regresas a Northstar Analytics y ves un selector de propiedades.
**Si no funcionó:** Usa una ventana privada y repite la autorización con la cuenta del propietario de la propiedad.
## 4. Selecciona la propiedad de producción
**Por qué existe este paso:** La autorización demuestra el acceso a la cuenta, pero la propiedad seleccionada determina qué datos se importan.
**Haz esto:** Selecciona la propiedad que coincidió exactamente con el host canónico en el paso 1, luego elige **Guardar e importar**.
**Cuándo funcionó:** El estado de la integración cambia a **Importación en cola** y muestra la propiedad seleccionada.
**Si no funcionó:** Vuelve al paso 3 con una cuenta autorizada. Compara los identificadores completos cuando las propiedades se vean similares.
## 5. Verifica la primera importación
**Por qué existe este paso:** Una insignia de conectado demuestra autorización, no que los datos utilizables llegaron al informe.
**Haz esto:** Después del período de espera indicado, abre **Informes → Consultas de búsqueda** y establece el rango de fechas a un período que tenga datos de Search Console.
**Cuándo funcionó:** Al menos una fila muestra una consulta, página de destino, fecha, clics o impresiones de la propiedad seleccionada.
**Si no funcionó:** Para **Importación en cola**, espera y vuelve a intentarlo. Para **Permiso caducado**, reconecta. Para **Sin datos**, verifica el rango de fechas y la propiedad de origen.
## Lista de verificación final
- La integración nombra la propiedad de producción prevista.
- Su estado es Conectado en lugar de simplemente En cola.
- El informe de consultas contiene una fila con fecha de esa propiedad.
- Un segundo administrador puede identificar qué cuenta posee la conexión.
## Solución de problemas
### El selector de propiedades está vacío
La cuenta de Google autorizada carece de acceso o se le eliminó el acceso. Reautoriza con un propietario de la propiedad y luego recarga el selector.
### La conexión se realiza correctamente pero el informe está vacío
Compara el rango de fechas del informe con Search Console, luego confirma el identificador exacto de la propiedad antes de desconectar.
### La importación vuelve repetidamente a En cola
Registra el sitio, el identificador de la propiedad, la hora de inicio y el estado más reciente, luego contacta al soporte. Esos detalles permiten al soporte inspeccionar la importación sin pedirte que repitas la autorización a ciegas.
## FAQ
[Añade de cinco a siete preguntas residuales sobre permisos, demora de datos, tipos de propiedad, reconexión y eliminación. No repitas los pasos.]
## Próximos pasos
[Ofrece una acción que use los datos importados, como revisar el primer informe de oportunidades de consulta.]
Ejemplos de diseño
Cada variante de galería debe mostrar los mismos requisitos previos, cinco pasos, estados de éxito, texto de recuperación, solución de problemas y verificación final.
Lista de verificación de calidad
Una guía es publicable solo cuando un revisor puede completarla desde un estado inicial limpio sin el autor.
- El hero indica un resultado comprobable, el lector previsto, el tiempo activo esperado, el tiempo de espera y la dificultad.
- Los requisitos previos nombran roles, acceso, versiones, herramientas, insumos, cargos y condiciones de seguridad que podrían bloquear un paso posterior.
- Cada paso comienza con un título imperativo y explica por qué, la acción, el éxito y la recuperación.
- El orden ha sido probado; mover un paso cambiaría, bloquearía o invalidaría el resultado.
- Las advertencias aparecen antes del riesgo, y los consejos opcionales nunca ocultan trabajo obligatorio.
- Las capturas de pantalla resuelven ambigüedades genuinas, tienen contexto de interfaz actual y explicaciones accesibles, y no son la única fuente de instrucciones.
- La verificación final confirma el resultado prometido, no el último clic.
- La solución de problemas cubre fallos observados o reproduciblemente creíbles con acciones específicas.
- Los datos HowTo coinciden exactamente con cada paso y propiedad visible, o la página usa Article en su lugar.
- Un segundo probador ha completado la guía en la cuenta, dispositivo, rol y versión compatibles.
Errores comunes
El fallo más frecuente es una transcripción de clics: «Abrir Configuración. Hacer clic en Integraciones. Hacer clic en Conectar». Omite por qué la propiedad importa, qué debería aparecer y cómo recuperarse de un permiso faltante.
Otros fallos son igualmente específicos:
- Ocultar requisitos previos dentro de los pasos. Descubrir en el paso 4 que el acceso de administrador tarda un día en obtenerse pierde el tiempo del lector y puede dejar un trabajo parcial abandonado.
- Poner advertencias después de las acciones. Una advertencia de eliminación debajo de la instrucción Eliminar no puede prevenir la eliminación.
- Usar el tiempo transcurrido como tiempo activo. «Tarda 40 minutos» es engañoso cuando el trabajo toma 10 minutos más una importación de 30 minutos. Indica ambos.
- Probar solo la cuenta del autor. Los administradores a menudo ven controles que los miembros ordinarios no ven. Prueba el rol indicado en el hero.
- Tratar el último clic como éxito. «Guardado» puede significar solo que se aceptó una solicitud. Verifica el estado o salida posterior.
- Dejar que el esquema se desvíe. Renombrar, reordenar o fusionar pasos visibles sin actualizar los datos HowTo crea dos procedimientos incompatibles en una misma URL.
Enlazado interno
Una guía práctica enlaza hacia afuera solo cuando el destino explica un requisito previo, respalda una decisión o proporciona el siguiente procedimiento. Define los términos especializados antes de la secuencia o en el primer uso.
Otras páginas deben enlazar a la guía cuando nombran la tarea exacta, pero no deben duplicar sus pasos. Una página de producto puede enlazar desde una capacidad hasta la configuración. Una guía definitiva puede enlazar desde una fase amplia hasta el procedimiento relevante. Un artículo de solución de problemas puede enlazar de vuelta al estado inicial de la guía después de resolver el síntoma.
No dupliques una guía de decisión «cómo elegir», una ruta de solución de problemas basada en síntomas o documentación general. Si una página hermana necesita más que un breve resumen de la misma secuencia, establece un procedimiento canónico y enlázalo. Mantén las variaciones específicas de versión en una sola página cuando la ruta principal sea compartida; divídelas solo cuando los pasos o requisitos previos difieran sustancialmente.
Cómo medir los resultados
La medición sigue la promesa de la guía: ¿se encontró el procedimiento para la tarea prevista, se seleccionó como fuente útil, se siguió y se conectó a un estado siguiente significativo? Usa el seguimiento de posiciones en IA para monitorear consultas recurrentes orientadas a objetivos, luego inspecciona el Seguimiento de consultas para ver la redacción de la respuesta, la URL citada, el motor y las fuentes de la competencia. El enlace directo funcional es abrir Seguimiento de consultas .
Registra el conjunto de consultas y una línea base previa a la publicación. Rastrea las citas por separado de las menciones de marca. En el sitio, usa evidencia de finalización como alcanzar la verificación final, seleccionar el CTA del siguiente paso, completar un evento de producto asociado o la reducción de la demanda de soporte. Cada una es evidencia, no prueba; la profundidad de desplazamiento no puede demostrar que el procedimiento funcionó.
FAQ
Preguntas frecuentes
¿Qué diferencia a una guía práctica de la documentación?
¿Cada paso necesita una captura de pantalla?
¿Cuántos pasos debe tener una guía práctica?
¿Debe una guía práctica incluir el esquema HowTo?
¿Dónde debe aparecer la solución de problemas?
¿Cómo debe medir un equipo una guía práctica?
Pon la guía en producción
Prueba el procedimiento con un lector representativo, luego usa el bloque de CTA para ofrecer una acción que se siga naturalmente de la finalización verificada.
Más tutoriales en esta sección
¿Listo para ponerlo en práctica?
Revisión gratuita · Prueba de 7 días · sin tarjeta de crédito