Cómo estructurar la navegación de la documentación

La navegación determina cómo los usuarios construyen un modelo mental de tu producto. Una navegación bien diseñada ayuda a los usuarios a encontrar respuestas rápidamente, entender cómo se relacionan las distintas partes del producto y sentir confianza de que están en el lugar correcto. Una mala navegación envía a los usuarios a los motores de búsqueda, a tickets de soporte o a la documentación de tus competidores.

Esta guía cubre cómo diseñar, validar y mantener una navegación de documentación que funcione para usuarios reales.

Antes de organizar páginas, alinéate con las personas que mejor conocen tu producto y tus usuarios.

Habla con fundadores, gerentes de producto y líderes de ingeniería antes de tomar decisiones estructurales. El objetivo es entender cómo funciona realmente el producto, no solo cómo se comercializa.

Preguntas que debes hacer:

• ¿Cuál es la forma más sencilla de explicar cómo funciona el producto?
• ¿Cuáles son los componentes fundamentales del producto?
• ¿Cómo adoptan los usuarios normalmente el producto? ¿Dónde se quedan atascados con más frecuencia?
• ¿Cuáles son las integraciones o dependencias más importantes?
• Si el producto se dividiera en diferentes capas, ¿cuáles serían? ¿Se organizaría por tareas que realizan las personas o por funcionalidades que utilizan?

Estas conversaciones revelan la estructura natural del producto y a menudo muestran dónde la navegación de la documentación se ha alejado de cómo los usuarios realmente piensan.

Las decisiones de navegación dependen de tu audiencia. Un desarrollador que integra una API navega de forma diferente a un administrador que configura ajustes o un usuario nuevo que sigue un flujo de incorporación.

Si tienes múltiples audiencias distintas, considera si necesitan estructuras de navegación separadas o si una estructura unificada puede atenderlas a todas. Consulta Entiende a tu audiencia para más información sobre cómo definir personas de documentación.

El error de navegación más común es organizar la documentación de la forma en que el equipo de producto piensa sobre el producto, en lugar de la forma en que los usuarios intentan lograr sus objetivos.

Compara estos dos enfoques para un producto de API:

La navegación centrada en el recorrido indica a los usuarios dónde se encuentran en un proceso. La navegación centrada en funcionalidades requiere que los usuarios ya sepan lo que están buscando.

La profundidad de navegación se refiere a cuántos niveles deben recorrer los usuarios para llegar al contenido. La amplitud se refiere a cuántos elementos aparecen en cada nivel.

Algunos principios:

• Mantén las secciones de nivel superior en siete elementos o menos. La carga cognitiva aumenta a medida que los usuarios necesitan examinar y evaluar más opciones.
• Prefiere la profundidad sobre la amplitud. Una sección de nivel superior con cinco subsecciones es más fácil de examinar que 20 elementos de nivel superior.
• No ocultes contenido crítico por debajo de dos niveles. Si los usuarios deben hacer clic en tres niveles para llegar a páginas que necesitan frecuentemente, considera promover ese contenido.

Las etiquetas de navegación deben coincidir con cómo los usuarios describen sus objetivos, no con cómo los ingenieros describen las funcionalidades.

• Usa verbos para secciones orientadas a tareas (“Autenticar”, “Desplegar”, “Monitorear”)
• Usa sustantivos para secciones de referencia (“Referencia de API”, “SDKs”, “Registro de cambios”)
• Evita terminología interna que los usuarios no reconocerán
• Mantén las etiquetas cortas, idealmente con menos de 4 palabras

Tu primera estructura de navegación es una hipótesis. Valídala antes de tratarla como permanente.

Usa herramientas de grabación de sesiones como FullStory o Hotjar y herramientas de analítica como Mixpanel para estudiar cómo los usuarios realmente se mueven por tu documentación. Busca:

• Puntos de entrada: ¿Dónde comienzan los usuarios? ¿Vienen de una búsqueda, un ticket de soporte o directamente de tu producto?
• Patrones de navegación: ¿Los usuarios siguen la estructura esperada o toman caminos inesperados?
• Puntos de fricción: ¿Dónde se detienen los usuarios, vuelven atrás o abandonan su sesión?
• Comportamiento de búsqueda: ¿Los usuarios buscan términos que no aparecen en tus etiquetas de navegación? Esto señala una discrepancia de terminología.

La analítica revela patrones, pero las conversaciones directas proporcionan el contexto detrás de ellos.

Pide a los usuarios que completen una tarea específica usando solo la documentación mientras narran su proceso de pensamiento. Dónde hacen clic primero y dónde se quedan atascados revela si tu navegación es intuitiva.

Los nuevos empleados de tu propio equipo son buenos sustitutos de los usuarios. Antes de que se familiaricen demasiado con el producto desde adentro, pídeles que encuentren respuestas a preguntas específicas usando solo la documentación. Sus instintos revelan suposiciones que tu navegación hace y que no son obvias para los recién llegados.

Si tu navegación de nivel superior tiene más de 7 u 8 elementos, los usuarios pasan más tiempo evaluando opciones que encontrando contenido. Agrupa temas relacionados en secciones con nombres significativos.

Si las páginas que los usuarios más necesitan están a dos o tres niveles de profundidad, promuévelas. Las páginas de alto tráfico deben ser fáciles de alcanzar desde el nivel superior o visibles en el primer nivel de cualquier sección relevante.

Si los usuarios dudan antes de hacer clic en un elemento de navegación, la etiqueta no está cumpliendo su función. Prueba si los usuarios pueden predecir lo que encontrarán antes de hacer clic describiendo lo que contiene.

A veces lo que parece un problema de navegación es en realidad una brecha de contenido. Si los usuarios buscan términos que no coinciden con ninguna página, puede que te falte contenido en lugar de tener etiquetas incorrectas. Distingue entre ambos antes de reestructurar.

La navegación debe evolucionar con tu producto y tus usuarios. No necesitas acertar en el primer intento.

Una cadencia práctica:

• Revisa la navegación cada vez que el producto lance cambios importantes. Las nuevas funcionalidades a menudo exponen brechas estructurales.
• Consulta la analítica de búsqueda trimestralmente para detectar términos que los usuarios buscan y que no se reflejan en tus etiquetas de navegación.
• Revisa la estructura de nivel superior anualmente. A medida que la documentación crece, lo que funcionaba con 20 páginas puede no funcionar con 200.

Para configurar la navegación en Mintlify—pestañas, grupos, anclas y orden de páginas—consulta la referencia de navegación.