La interfaz de Izly y las voces de los vídeos están en inglés y turco. Las guías y las automatizaciones funcionan con sitios web en cualquier idioma.
¿Cómo creo documentación de formación de software?
Una buena documentación de formación es un conjunto de guías cortas, una por cada tarea que una persona nueva debe aprender. El método de abajo sirve para cualquier software que funcione en el navegador.
- Elige la tarea. Una tarea, un resultado, por ejemplo “Enviar una solicitud de gastos”.
- Grábala una vez. Haz la tarea en una cuenta de prueba mientras el grabador captura cada clic.
- Limpia los pasos. Reescribe los pasos vagos, borra los clics accidentales y une los muy pequeños.
- Añade consejos y avisos. Marca lo que no se puede deshacer y en qué suele fallar la gente.
- Tapa los datos privados. Elimina de las imágenes nombres, correos, importes e identificadores.
- Publica. Envía un enlace, un PDF o un archivo de Word.
- Mantenla al día. Dale a la guía una persona responsable y una fecha de revisión.
¿Qué tareas debo documentar primero?
Empieza por las tareas que más preguntas generan. Pregunta a las tres últimas personas que se incorporaron sobre qué tuvieron que preguntar en su primer mes. La configuración de accesos, el primer informe mensual y el formulario que todo el mundo rellena el segundo día suelen estar en la lista.
Deja fuera las tareas que ocurren una vez al año y las que cambian cada semana. Una lista corta de diez guías que la gente usa vale más que cien que nadie abre.
¿Cómo es una guía terminada?
Ejemplo: “Enviar una solicitud de gastos” en una aplicación web de finanzas, grabada en una cuenta de prueba con un recibo inventado. Izly genera el texto de partida a partir de tus clics; tú lo reescribes en el editor, en el idioma que necesite tu equipo.
| Texto de partida | Después de limpiarlo |
|---|---|
| Click New | Haz clic en Nueva solicitud, arriba a la derecha |
| Click Amount, type 48.50 | Escribe en Importe la cantidad que figura en el recibo |
| Click Upload | Haz clic en Subir y elige la foto del recibo |
| Click Send | Haz clic en Enviar. Aviso: una solicitud enviada no se puede editar |
El último paso muestra por qué importan los avisos. El bloque de aviso queda justo en el paso al que pertenece, así que nadie tiene que bajar hasta el final de la página para encontrarlo.
¿Cómo evito que los datos privados salgan en las capturas?
Primero, usa una cuenta de prueba y registros inventados. Segundo, tapa lo que quede. Una forma dibujada sobre un nombre no lo elimina del archivo de imagen, así que usa un método que cambie los píxeles. En Izly los píxeles tapados se eliminan en el servidor. Las contraseñas nunca se graban.
Tapas las zonas sensibles a mano en el editor, y conviene que revises tú la guía entera antes de compartirla.
¿En qué formato debo publicarla?
| Formato | Úsalo cuando | Plan |
|---|---|---|
| Enlace para compartir | La gente debe ver siempre la versión actual. Puedes desactivar el enlace en cualquier momento | Todos los planes |
| Insertar | La guía debe estar dentro de una página de ayuda o de una intranet | Todos los planes |
| Necesitas un documento para repartir, una carpeta de auditoría o lectura sin conexión | Todos los planes, con un pequeño pie de página en Free | |
| Word | Alguien va a editar la guía o a colocarla dentro de un documento mayor | Pro y Studio |
| HTML | Quieres publicar la guía en tu propio sitio | Pro y Studio |
| Markdown | La guía va a una wiki o a una carpeta de documentación | Pro y Studio |
| Vídeo narrado | Quienes prefieren escuchar, o una introducción para el primer día. Las voces son hoy en inglés y turco | Prueba gratuita de 3 guías, 15 al mes en Pro, sin límite en Studio |
Un enlace es la mejor opción por defecto porque una actualización llega a todos a la vez. Un PDF o un archivo de Word es una copia desde el momento en que se exportó.
¿Cómo mantengo la documentación de formación al día?
- Nombra a una persona responsable de cada guía. Una guía sin responsable es la primera en quedarse anticuada.
- Escribe una fecha de revisión y mírala cuando el software publique un cambio.
- Edita solo el paso que cambió. No hace falta volver a grabar toda una guía por un botón que se movió.
- Pregunta a quien la lee. Una sola línea, “¿Era correcta esta guía?”, encuentra los errores más rápido que una revisión anual.
¿Qué no puede cubrir este método?
Izly graba tareas en Chrome de escritorio. Un programa instalado en el equipo, o una tarea en el móvil, no se puede grabar. Una guía muestra cómo hacer una tarea; no enseña por qué existe un proceso, así que complétala con un procedimiento escrito cuando importe el motivo.
La interfaz de Izly y las voces de los vídeos están en inglés y turco. Las guías funcionan con sitios web en cualquier idioma y los textos de los pasos los puedes escribir en español.
¿Cómo grabo documentación de formación con Izly?
Izly (izly.io) es una extensión de Chrome que convierte una tarea que haces una vez en tu navegador en una guía paso a paso, un vídeo narrado y una automatización sin código que repite la tarea. Para la documentación de formación importan los dos primeros: la guía y el vídeo salen de la misma grabación.
Cada clic y cada texto escrito se convierte en un paso con su captura, y lo ordenas en el editor: edita textos, reordena, une, añade un bloque de consejo, aviso o título, recorta, añade flechas y tapa zonas sensibles. El plan Free tiene 10 guías y PDF. Mira los precios o empieza gratis.
Preguntas frecuentes
¿Cuántas guías necesita un conjunto de formación?
Empieza por las diez tareas que más preguntas causaron en los últimos meses. Añade una guía cuando alguien pregunte lo mismo dos veces. El número importa menos que el hecho de que la gente abra las guías.
¿Debo usar vídeo o guías escritas?
Usa pasos escritos para las tareas que la gente repite y consulta, y un vídeo narrado como introducción. Ambos pueden salir de una misma grabación, así que no tienes que elegir de antemano. Las voces del vídeo son en inglés y turco.
¿Quien lee las guías necesita una cuenta?
Quien mira las guías nunca paga. Los planes se cobran por creador, así que solo pagan las personas que graban y editan guías, y el plan Free cubre 10 guías.
¿Puedo convertir la misma guía en un documento para repartir?
Sí. La exportación a PDF está en todos los planes, con un pequeño pie de página en Free. Word, HTML y Markdown están en Pro y Studio.
¿Conviene documentar software que cambia a menudo?
Sí, si actualizar es barato. Como cada paso es independiente, solo editas el paso que cambió. Esa es la razón para grabar una guía en lugar de pegar capturas a mano en un documento.
Páginas relacionadas
Graba una vez y deja que la guía se escriba sola
Con Izly haces la tarea una vez en el navegador. Los clics y las capturas se convierten en una guía paso a paso que editas, compartes, conviertes en un vídeo narrado o ejecutas de nuevo por cada fila de una tabla. La interfaz y las voces del vídeo están en inglés y turco; las guías y las automatizaciones funcionan con sitios web en cualquier idioma.