Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt

Use this file to discover all available pages before exploring further.

Esta página explica por qué y cómo organizar tu documentación de manera que tenga sentido para tus usuarios.

​
¿Por qué es importante la navigation?

La navigation puede parecer poco importante porque los usuarios con experiencia que buscan respuestas específicas suelen ir directamente a las páginas mediante un motor de búsqueda o la barra de búsqueda de tu sitio de documentación. Pero la arquitectura de la información de tu documentación ayuda a las personas a crear un modelo mental sobre cómo entender tu producto y proporciona estructura tanto para las personas como para las herramientas de IA que usan tu documentación. Una navigation bien diseñada ayuda a las personas a comprender rápidamente tu producto y a tener éxito al usar tu documentación.

​
Define la base con las personas involucradas

Alinea con partes interesadas clave como los fundadores, los responsables de producto o los líderes de ingeniería cómo funciona tu producto, qué es lo más importante y cómo deberían interactuar los usuarios con él. Preguntas de ejemplo para plantear:
  • ¿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 suelen adoptar los usuarios el producto? ¿Dónde se atascan con mayor frecuencia?
  • ¿Cómo influye la arquitectura del producto en la forma en que las personas lo utilizan?
  • ¿Cuáles son las integraciones o dependencias más importantes?
  • ¿Qué está cambiando o evolucionando en el producto?
  • Si el producto se dividiera en diferentes capas, ¿cuáles serían? ¿Sería por las tareas que realizan las personas o por las funcionalidades que utilizan?

​
Valida tus hipótesis

Una vez que hayas definido una estructura, necesitas comprobar si realmente funciona para usuarios reales. La forma en que las personas navegan por tu documentación suele revelar lagunas en tu arquitectura de la información que los equipos internos podrían pasar por alto.

​
Rastrea recorridos reales de usuarios

Usa herramientas como reproducciones de sesión (por ejemplo, FullStory, Hotjar) o Analytics (por ejemplo, Mixpanel) para estudiar cómo los usuarios navegan por tu documentación. Presta atención a:
  • Puntos de entrada: ¿Dónde comienzan los usuarios su recorrido? ¿Llegan desde una búsqueda, un ticket de soporte o directamente desde tu producto?
  • Patrones de navegación: ¿Siguen la estructura de navigation esperada o toman desvíos inesperados?
  • Puntos de fricción: ¿Dónde se detienen, retroceden o abandonan la sesión? Esto podría indicar una organización poco clara o contenido faltante.
  • Comportamiento de búsqueda: ¿Buscan términos que no existen en tu documentación? Esto podría evidenciar carencias en tu contenido o desalineación en la terminología.

​
Prueba con usuarios reales

Analytics ayuda a identificar tendencias, pero las conversaciones directas ofrecen insights más profundos. Realiza llamadas de investigación en las que los clientes intenten encontrar respuestas a preguntas específicas. Pídeles que narren su proceso de pensamiento mientras navegan. Las nuevas incorporaciones también son un excelente proxy de usuarios, ya que no tienen tanto contexto previo como los miembros con más antigüedad de tu equipo. Antes de que se familiaricen demasiado con tu producto desde dentro, pídeles que completen una tarea usando únicamente la documentación. Pídeles que detallen cómo abordaron la tarea: dónde hicieron clic primero, cómo interpretaron los nombres de las secciones y dónde se atascaron. Sus intuiciones pueden revelar si tu documentación es intuitiva o si presupone demasiado conocimiento previo.

​
Identifica desafíos comunes

Basándote en tus observaciones, busca estos problemas comunes de navigation:
  • Categorías sobrecargadas: Demasiadas secciones de nivel superior pueden abrumar a las personas usuarias. Considera agrupar los temas relacionados.
  • Contenido esencial oculto: No ocultes información crítica. Prioriza el contenido al que se accede con frecuencia.
  • Nombres de sección poco claros: Si las personas dudan antes de hacer clic, tus labels pueden no ser intuitivos. Alinea la terminología con la forma en que tu audiencia piensa de manera natural.
Diseña una arquitectura de la información elegante y funcional, pero recuerda: es difícil crear documentación que funcione para absolutamente todas las personas. Considera a la mayoría de tu base de usuarios y qué les ayudará a tener éxito.

​
Itera con el tiempo

Ante todo, sé flexible. Tu navigation debe evolucionar junto con tu producto y las necesidades de tus usuarios. No tienes que acertar a la primera.