Si buscas «manual de usuario de software» encontrarás plantillas de documentos larguísimos: introducción, alcance, requisitos del sistema, glosario, capítulos por pantalla. Tienen sentido para un programa que se instala y no cambia en dos años. Para un SaaS que publica cambios cada semana, no.
Nadie lee un manual de principio a fin. Se busca una tarea («cómo invito a un compañero»), se lee el paso que falta y se vuelve al trabajo.
La respuesta corta
El manual de usuario de un software moderno es un centro de ayuda: un conjunto de artículos cortos, uno por tarea, organizados en colecciones y fáciles de buscar. Debe tener una guía de primeros pasos, un artículo por cada tarea habitual, explicaciones de los conceptos propios del producto, respuestas a los errores y problemas frecuentes, y lo relativo a la cuenta y la facturación. Cada artículo sigue la misma plantilla: un título con las palabras del cliente, la respuesta en el primer párrafo, los pasos numerados, lo que puede salir mal y enlaces a lo relacionado. Se mantiene al día revisando los artículos que tocan cada cambio del producto y escribiendo lo que falta a partir de las preguntas de soporte.
Las partes del manual
| Parte | Qué contiene | Ejemplo |
|---|---|---|
| Primeros pasos | Lo mínimo para sacar valor el primer día | «Crea tu primer proyecto en cinco minutos» |
| Tareas | Un artículo por cada cosa que se hace en el producto | «Cómo invitar a un compañero a tu equipo» |
| Conceptos | Lo que es propio de tu producto y hay que entender | «Qué es un espacio de trabajo y en qué se diferencia de un proyecto» |
| Problemas frecuentes | Errores y qué hacer | «No me llega el correo de invitación» |
| Cuenta y facturación | Planes, pagos, facturas, baja | «Cómo descargar tus facturas» |
| Integraciones | Una por cada herramienta que conectas | «Conectar con Slack» |
| Referencia | Lo técnico, si hay API | «Límites de la API» |
Plantilla para cada artículo
Título: Cómo [tarea, con las palabras del cliente]
[Una o dos frases con la respuesta directa.]
Antes de empezar
- [Permiso o plan necesario, si lo hay]
Pasos
1. [Acción en la pantalla, con el nombre exacto del botón]
2. [...]
3. [...]
Si algo no funciona
- [Problema habitual]: [qué hacer]
Relacionado
- [Artículo 1]
- [Artículo 2]
Última revisión: [fecha]
Un ejemplo completo
Cómo invitar a un compañero a tu equipo
Puedes invitar a otras personas desde Ajustes › Equipo. Recibirán un correo con un enlace para unirse.
Antes de empezar: necesitas ser administrador de la cuenta. El número de personas depende de tu plan.
Pasos
1. Ve a Ajustes › Equipo.
2. Pulsa Invitar.
3. Escribe el correo de la persona y elige su rol.
4. Pulsa Enviar invitación.
Si algo no funciona
- No le llega el correo: que revise la carpeta de spam; puedes reenviar la invitación desde la misma pantalla.
- El botón Invitar no aparece: no tienes permisos de administrador o has llegado al límite de tu plan.
Fíjate en que responde en la primera frase, usa los nombres exactos de la pantalla y se anticipa a los dos problemas que más se preguntan.
Cómo escribir para que se lea
- El título, con las palabras del cliente: «Cómo cancelar mi suscripción», no «Gestión del ciclo de vida de la cuenta».
- Un artículo, una tarea. Si tiene dos, son dos artículos.
- Capturas solo donde ayudan, y sabiendo que habrá que cambiarlas cuando cambie la pantalla.
- Nada de «sencillamente» ni «simplemente»: si el cliente está leyendo, no le ha resultado sencillo.
- Fecha de revisión al final, para saber cuándo volver a mirarlo.
Más sobre esto, en un centro de ayuda que de verdad se lee.
Cómo mantenerlo al día
El manual de un SaaS se queda viejo solo. Para evitarlo:
- Cada cambio del producto lleva su lista de artículos afectados, igual que lleva sus pruebas. Lo publicas a la vez que las notas de versión.
- Las preguntas de soporte dicen lo que falta: si algo se pregunta varias veces por semana y no tiene artículo, se escribe. Cómo verlo, en detectar qué le falta a tu documentación.
- Revisión trimestral de los artículos más leídos.
El manual también lo lee la IA
Si usas un agente de IA en soporte, el manual es lo que usa para responder. Los artículos cortos, con una tarea cada uno y la respuesta al principio, son también los que mejor funcionan para la IA. Un manual bien hecho sirve dos veces. Cómo prepararlo, en preparar la documentación para un agente de IA.
Cómo lo hace Intake
El centro de ayuda de Intake es el manual: colecciones, artículos con un editor de bloques, búsqueda para tus clientes en tu propio dominio y un asistente que responde con los artículos publicados. Los mismos artículos alimentan al agente de IA de la bandeja, y la sección de Recomendaciones agrupa lo que el agente no supo responder y propone el artículo nuevo o la corrección, que no se publica hasta que alguien lo aprueba. Lo tienes en el centro de ayuda de Intake.
Preguntas frecuentes
¿Qué debe tener un manual de usuario de software?
Primeros pasos, un artículo por cada tarea, explicación de los conceptos propios, problemas frecuentes, cuenta y facturación, integraciones y, si hay API, una parte de referencia.
¿Manual en PDF o centro de ayuda?
Para un software que cambia a menudo, centro de ayuda: se busca, se actualiza artículo a artículo y se enlaza desde la aplicación. Un PDF se queda viejo en cuanto cambia una pantalla.
¿Cuánto debe ocupar cada artículo?
Lo que necesite una tarea: normalmente entre cien y cuatrocientas palabras. Si pasa de ahí, probablemente son dos tareas.
¿Cómo mantengo el manual actualizado?
Con una lista de artículos afectados en cada cambio del producto, escribiendo lo que se pregunta en soporte y una revisión trimestral de los más leídos.
¿Quién escribe el manual en una startup?
Quien atiende soporte, porque sabe lo que preguntan los clientes, con una revisión de producto para que los pasos sean exactos.
