Caso de estudio · Documentación para usuarios finales
Documentación orientada a tareas para mobohubb
Organicé y redacté documentación orientada a tareas para las cuatro aplicaciones de mobohubb. El portal separa la configuración administrativa de las tareas de campo y ofrece seis rutas de incorporación en 86 guías.
- Autor
- Christian Arango
- Rol
- Escritor técnico e ingeniero de documentación
- Sitio en producción
- mobohubb.readme.io
- Captura
- Sitio público, 13 de octubre de 2026
El problema
Cuatro aplicaciones para tareas de lectura distintas
mobohubb ayuda a equipos en movimiento a gestionar horarios, registro de tiempo, tareas, formularios y puntos de control QR/NFC. Sus lectores van desde administradores en un portal web hasta empleados de campo con un teléfono o un quiosco compartido.
86 guías orientadas a tareas para cuatro aplicaciones
941 capturas ubicadas paso a paso en 83 de 86 páginas
74 guías redactadas como procedimientos numerados
~40k palabras de orientación publicada
Arquitectura de información
Organizar la ayuda por aplicación y luego por tarea
Los lectores llegan sabiendo en qué aplicación están, no qué función necesitan; por eso cada aplicación tiene su propia barra lateral, con la forma de sus menús.
Versiones de ReadMe como selector de aplicaciones
Cada aplicación vive en su propia versión de ReadMe, así que el encabezado cambia toda la barra lateral sin mantener cuatro proyectos.
Separar el contenido administrativo del contenido de campo
La configuración vive en Portal, así que los empleados de campo nunca recorren ajustes que no usan.
Producto bilingüe, documentación en inglés
El portal funciona en español o inglés; las guías tratan el cambio de idioma como una tarea propia.
Mira las secciones y guías de cada aplicación
| Aplicación | Secciones | Guías |
|---|---|---|
| Portal/docs | Inicio rápido · Dashboard · Perfil · Administración del sitio · Configuración · Configuración de informes · Productividad · Horario · Colaboración | 52 |
| Mobile app/v1.2/docs | Inicio rápido · Perfil · Funciones · Menú lateral · Horario · Alertas | 27 |
| Web app/v1.3/docs | Vista general · Inicio de sesión · Inicio rápido | 3 |
| Kiosk app/v1.4/docs | Vista general · Inicio de sesión · Inicio rápido para administradores de sitio · Inicio rápido para usuarios | 4 |
Mira cómo se construyó la página de inicio
Un único bloque HTML en la página de inicio de ReadMe, con su propia hoja de estilos acotada. Solo hace una pregunta: «¿Qué aplicación usas?». Cuatro tarjetas grandes responden y abren la primera guía de cada aplicación.
Marca sin presupuesto para un tema propio
Un degradado suave y tarjetas de vidrio esmerilado elevan el aspecto estándar de ReadMe sin desarrollar un tema personalizado.
Ancho completo dentro de ReadMe
Los overrides del contenedor de contenido de ReadMe eliminan su ancho y padding para que el fondo llegue de borde a borde.
Pie de página con marca
Logo, copyright y enlaces sociales en el color del producto, que pasan a una columna centrada por debajo de 600 px.
/* Frosted-glass app cards */
.card {
background: rgba(255, 255, 255, 0.6);
border: 2px solid rgba(234, 241, 251, 0.3);
border-radius: 20px;
backdrop-filter: blur(8px);
transition: transform 0.2s;
}
.card:hover { transform: translateY(-4px); }Redacción
Mantener las instrucciones cerca de la tarea
Los empleados de campo leen desde un teléfono, durante el turno y casi siempre para una sola tarea. Cada guía les ayuda a encontrar su paso y compararlo con la pantalla.
- 63 de 86
Primero, el resultado
Las guías comienzan con “In this guide you’ll learn” para que el lector sepa en segundos que está en la página correcta.
- 941 capturas
Una pantalla por cada paso
Las capturas de teléfono son estrechas, como el dispositivo; las de Portal son anchas.
- Estilo
Resaltar lo que hay que tocar
Pasos en imperativo con la etiqueta exacta de la interfaz en negrita: toca Take a break.
- 42 guías
Notas donde suelen aparecer errores
Un callout en el paso exacto donde el lector puede equivocarse, como qué credenciales usar.
Mira cómo empieza la guía Time Clock, en Markdown
# Time Clock
Discover how to use the **Time Clock** feature in mobohubb to log work
hours and manage breaks.
**In this guide you'll learn**
* How to **clock in** and **clock out** with the Time Clock
* The differences between **automatic**, **manual**, and **no-break** modes
* How to record **breaks** and review a summary of hours worked
## Clock in
1. Tap the **Time Clock** icon in the footer.
2. (Optional) add a note.
3. Press and hold the clock button until the **green ring** completes (≈ 5 s).
<Image align="center" border={true} width="30%" src="…" />Incorporación
Un punto de partida relevante para cada audiencia
En vez de una sola página de introducción, el portal ofrece seis inicios rápidos, cada uno escrito para una audiencia y una tarea.
Enlaces cruzados en lugar de repetición
Los inicios rápidos enlazan a las guías completas en vez de repetirlas.
Pestañas para recorridos densos de interfaz
Las pantallas con muchas regiones se recorren una región a la vez con pestañas de ReadMe.
Contenido al día
La mayoría de las guías se actualizó entre marzo y junio de 2025, con ediciones hasta mayo de 2026 a medida que cambió la interfaz.
Mira los seis inicios rápidos y qué cubre cada uno
| Audiencia | Guía | Qué permite completar |
|---|---|---|
| Organizaciones nuevas | New Users: Quick Start Guide | El asistente de configuración y cinco pasos con seguimiento —Branding, Scan Point, Task, Form/Checklist e Invite your team—, cada uno asociado al indicador de avance 1/5–5/5 del portal. |
| Clientes existentes | Existing Users: Quick Start Guide | El paso del portal clásico al rediseñado: iniciar sesión con las credenciales actuales y encontrar herramientas conocidas en el nuevo diseño. |
| Empleados de campo | Mobile App: Quick Start Guide | Iniciar sesión, escanear códigos QR, usar el reloj, completar tareas y llenar formularios. |
| Personal de oficina | Web App: Quick Start Guide | Iniciar sesión, elegir una sede, navegar y trabajar con formularios y borradores en el navegador. |
| Administradores de sitio | Kiosk: Site Administrator Quick Start | Convertir una tableta o iPad en una estación compartida de registro y configurarla para cada sede. |
| Usuarios de quiosco | Kiosk: User Quick Start | Registrar entradas, salidas y descansos en un dispositivo compartido mediante PIN y foto. |
El resultado
Lo que demuestra el portal publicado
Análisis de audiencias
Rutas separadas para administradores, personal de oficina, empleados de campo y usuarios de quiosco.
Redacción de procedimientos y documentación visual
74 guías paso a paso con resúmenes de resultados, etiquetas exactas de la interfaz y 941 capturas dimensionadas según el dispositivo que muestran.
Front end en una plataforma alojada
Una página de inicio personalizada en HTML/CSS dentro de ReadMe, con las versiones reutilizadas como selector de aplicaciones.
Mantenimiento
Guías mantenidas al día con un rediseño del producto más de un año después del lanzamiento.
Documentación desactualizada
Enlace roto
Guía pendiente