Comienza por entender a tus usuarios y producto
Establece las bases con las partes interesadas
- ¿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?
Conoce para quién escribes
Organiza por recorrido del usuario, no por funcionalidades del producto
| Centrado en funcionalidades (evitar) | Centrado en el recorrido (mejor) |
|---|---|
| API principal | Comenzar |
| Autenticación | Autenticar |
| Webhooks | Enviar tu primera solicitud |
| Límites de tasa | Manejar errores |
| SDKs | Ir a producción |
Gestiona la profundidad y la amplitud
- 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.
- 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
Valida tus suposiciones
Rastrea los recorridos reales de los usuarios
- 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.
Prueba con usuarios reales
Identifica y corrige problemas comunes
Secciones de nivel superior sobrecargadas
Contenido esencial enterrado
Nombres de sección poco claros
Itera con el tiempo
- 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.
Preguntas frecuentes
¿Debería organizar la navegación por funcionalidades del producto o por objetivos del usuario?
¿Debería organizar la navegación por funcionalidades del producto o por objetivos del usuario?
¿Cuántas secciones de navegación de nivel superior debería tener?
¿Cuántas secciones de navegación de nivel superior debería tener?
¿Cómo manejo documentación que sirve a múltiples audiencias?
¿Cómo manejo documentación que sirve a múltiples audiencias?
Primero, decide si tus audiencias son lo suficientemente diferentes como para necesitar estructuras separadas. Si un administrador y un desarrollador ambos necesitan comenzar, una sección compartida “Comenzar” puede funcionar bien con subsecciones específicas por audiencia. Si sus recorridos son fundamentalmente diferentes—productos separados, personas separadas—considera sitios de documentación separados o navegación basada en pestañas que separe claramente los dos caminos.
¿Cuándo debería reorganizar mi navegación?
¿Cuándo debería reorganizar mi navegación?
¿Cómo evito que la navegación se desordene a medida que la documentación crece?
¿Cómo evito que la navegación se desordene a medida que la documentación crece?