Usa esta plantilla
Una buena guía de usuario de software es más corta, más precisa y más centrada en las tareas que un manual completo, y a menudo resulta más útil. Con Trupeer, puedes ahorrar horas en la redacción de guías de usuario empezando con una plantilla gratuita de guía de usuario de software, personalizándola con tus directrices de marca y usando nuestro creador de manuales con IA para convertir recorridos del producto en atractivas guías en vídeo.
¿Qué es una plantilla gratuita de guía de usuario de software?
Una plantilla gratuita de guía de usuario de software es una estructura reutilizable para la documentación que leen tus usuarios finales: cómo hacer las cosas para las que sirve el software, escrita para la persona que lo utiliza en lugar de para quien lo construye o lo opera.
Es un miembro de una familia más amplia. La documentación de referencia, los registros de arquitectura, los runbooks operativos y las notas de versión sirven a lectores distintos, y la página de documentación de software explica cómo se dividen. Esta página trata de la que tus clientes abren realmente.
La plantilla no es la guía. La lista de secciones tarda veinte minutos en escribirse. Lo que determina si una guía de usuario funciona es una suposición estructural que la mayoría de las plantillas heredan sin darse cuenta, y es incorrecta.
El formato sigue al uso. Un archivo Word de plantilla gratuita de guía de usuario de software se adapta a una guía entregada como documento, que ahora es el caso minoritario y sigue siendo habitual en software on premise y en productos regulados; y un archivo Word de plantilla de manual de usuario es la misma tradición con un nombre más antiguo. Un diseño gratuito de plantilla de guía de usuario paso a paso en Word es el punto de partida común más cercano. Un diseño de plantilla gratuita de guía de usuario de software en PPT se adapta a material de formación derivado de la guía, en lugar de a la guía en sí; y un archivo Excel de plantilla gratuita de guía de usuario de software se adapta al inventario de contenido, en lugar de a la guía. La mayoría de las guías de usuario de software ahora viven en un sitio de ayuda, y eso cambia la estructura considerablemente, por la razón que se indica a continuación.
Nadie lee una guía de usuario desde el principio
Mira las analíticas de cualquier sitio de ayuda en línea y un dato resuelve el debate.
La proporción de visitas que empiezan en la página de inicio o en la página de contenidos es pequeña. La mayoría de los usuarios llegan directamente a una página profunda, desde un motor de búsqueda o desde un enlace de ayuda dentro del producto, con una única pregunta concreta.
No leyeron la introducción. No saben en qué capítulo están. No han visto la sección de terminología, las instrucciones de configuración ni la nota del capítulo dos en la que se explica que todo lo que viene después asume una cuenta configurada.
Sin embargo, casi todas las guías de usuario están estructuradas como un libro: una página de contenidos, capítulos en un orden lógico y páginas que asumen que el lector ha recorrido las anteriores. Esa estructura se hereda de los manuales impresos, donde era correcta, y sobrevive en la ayuda en línea donde ya no lo es.
El resultado es un documento coherente para su autor y roto para su lector real. Una página que empieza con "siguiendo desde la sección anterior" es un callejón sin salida para el setenta por ciento de las personas que no llegaron desde esa sección anterior.
Cómo personalizar esta plantilla en Trupeer
Paso 1: Abre la sección de plantillas
Ve a la sección de Plantillas desde la navegación principal.
Paso 2: Selecciona y abre una plantilla
Haz clic en cualquier plantilla con la que quieras trabajar para abrirla.
Paso 3: Amplía la vista de la plantilla
Si es necesario, amplía la vista de la plantilla para ver el diseño completo y los detalles con claridad.
Paso 4: Edita la plantilla
Haz clic en Editar para empezar a modificar la plantilla seleccionada.
Dentro del editor, puedes:
Añadir secciones nuevas
Definir o actualizar reglas de formato
Añadir un logotipo y ajustar su posición y la configuración relacionada
Paso 5: Guarda tu plantilla personalizada
Después de realizar todos los cambios necesarios, haz clic en Guardar para almacenar la plantilla actualizada como tuya.
Paso 6: Previsualiza y ajusta la plantilla
Cuando quieras ver cómo se ve tu plantilla personalizada, abre la Previsualización.
Desde la pantalla de previsualización, puedes seguir haciendo ajustes directamente si es necesario, asegurándote de que la plantilla aparezca exactamente como la quieres.
Con una plantilla de guía de usuario de software puedes:
Ahorrar horas en la redacción: Omite la página en blanco con una estructura creada para guías de usuario.
Reducir los tickets de soporte: Las guías claras ayudan a que los usuarios se atiendan por sí mismos.
Mantenerte alineado con la marca: Aplica tu logotipo, tipografías y colores usando el kit de marca de Trupeer.
Mejorar la adopción: Las guías centradas en las tareas ayudan a los usuarios a obtener valor más rápido.
Añadir recorridos en vídeo: Inserta vídeo para los pasos que son difíciles de explicar con texto.
Llegar a usuarios globales: Traduce guías de usuario a 65+ idiomas con un solo clic.
Cada página es la página uno
La regla de diseño se sigue directamente. Escribe cada página como si fuera la única que el lector verá alguna vez, porque para la mayoría de ellos lo es.
Seis consecuencias, y todas son baratas.
Indica en la página lo que esta página asume. No en un prefacio. Si la tarea requiere un rol de administrador, una integración configurada o un paso de configuración completado, dilo en las dos primeras líneas, donde alguien pueda descubrir que está en el lugar equivocado antes de pasar cinco minutos averiguándolo.
Repite en lugar de hacer referencias cruzadas. Tres líneas de requisitos previos repetidos son más baratas que un enlace que el lector tiene que seguir, leer y volver a consultar. La repetición ofende a los escritores y ayuda a los lectores, y el lector es para quien estás escribiendo.
Elimina cualquier referencia posicional. Como se describe arriba, en la sección anterior, usando el método de 5.2. Cada una de estas asume un orden de lectura que la mayoría de los lectores no siguió. Sustitúyelo por la instrucción real o por un enlace con nombre.
Titula la página como la pregunta, no como la función. Se trata más abajo, porque ahí está la diferencia entre ser encontrado y no.
Termina con uno o dos próximos pasos elegidos. No un árbol de navegación. El lector ha terminado algo y normalmente hay una siguiente cosa obvia, así que nómbrala.
Fusiona cualquier página que no pueda mantenerse por sí sola. Si una página realmente no tiene sentido sin otra, entonces son una sola página que se dividió por conveniencia del autor.
Por lo tanto, la mejor plantilla gratuita de guía de usuario de software es la que te permite escribir de esta manera. La prueba tarda segundos. Abre cualquier página de tu guía en frío, como si hubieras llegado desde una búsqueda, y pregunta si podrías completar la tarea. La mayoría de las guías fallan esto en la mayoría de sus páginas, y los fallos se concentran en los capítulos del medio, donde los autores tenían la mayor parte del contexto en la cabeza.
Qué debe contener una página de guía de usuario de software
Componentes para una sola página, ya que la página, y no el libro, es la unidad.
Componente | Qué hace |
|---|---|
Título como la pregunta del usuario | Lo que escribiría o preguntaría, no cómo se llama internamente la función. |
Para qué es esta página | Una línea. Lo que habrás logrado al final. |
Lo que asume | Rol, permisos, configuración previa, estado previo. Expresado, no enlazado. |
Pasos numerados | Una acción cada uno, en el orden en que se realiza. |
Lo que deberías ver | Por paso, donde el resultado no sea evidente, para que el lector sepa si debe continuar. |
Captura de pantalla o vídeo corto donde el reconocimiento supera a la descripción | Solo cuando se gana su lugar, por los motivos que se explican a continuación. |
Problemas comunes | Dos o tres, tomados de tickets de soporte en lugar de imaginados. |
Siguientes pasos | Uno o dos, elegidos deliberadamente. |
Fecha de verificación y versión más recientes | Cuándo alguien realizó estos pasos por última vez y qué versión del producto. |
En conjunto, también necesitas una búsqueda que funcione, una forma para que los lectores informen de que una página está mal y un responsable. El enlace para informar es el mecanismo de calidad más barato disponible y casi nadie lo tiene.
Plantilla de guía de usuario de software gratuita: la estructura que debes copiar
Rellenada con un ejemplo real en lugar de marcadores de posición. El software es de gestión de clínicas veterinarias.
Copia desde aquí.
Título. Cómo reembolsar a un cliente. No: procesamiento de reversión de nota de crédito.
Para qué es esta página. Devolver dinero a un cliente por una factura que ya ha pagado y registrarlo correctamente en las cuentas de la clínica.
Lo que asume. Tienes el permiso de Facturación. Las clínicas del plan Estándar lo tienen de forma predeterminada solo para los responsables de clínica. La factura se ha pagado y conciliado. Si no se ha pagado, estás buscando cancelar una factura, que es una página diferente y está enlazada al final.
Pasos.
Abre el registro del cliente y selecciona la pestaña Facturación. Deberías ver una lista de facturas con un estado para cada una.
Busca la factura pagada. Las facturas pagadas muestran una marca verde. Si aparece un reloj ámbar, aún no se ha conciliado y debes esperar a la conciliación antes de reembolsar.
Selecciona la factura y, a continuación, Reembolso. Se abre un panel de reembolso que muestra el importe total.
Introduce el importe del reembolso. Se permiten reembolsos parciales. El importe no puede superar el total pagado.
Selecciona un motivo de la lista. Esto aparece en el extracto del cliente, así que elige el que estás dispuesto a que lean.
Selecciona Procesar reembolso. Deberías ver una confirmación con una referencia de reembolso que empieza por REF.
Qué deberías ver después. El estado de la factura cambia a Reembolsado o Reembolsado parcialmente. El reembolso aparece en el libro diario en quince minutos.
Problemas comunes.
El botón Reembolso aparece en gris, lo que normalmente significa que la factura no se ha conciliado. Espera y actualiza.
El reembolso no aparece en el libro diario, lo que normalmente significa que se procesó después del cierre del libro diario y aparecerá mañana.
No puedes ver la pestaña Facturación en absoluto, lo que significa que no tienes el permiso de Facturación. Tu responsable de clínica puede concederlo.
Siguientes pasos. Solo dos. Cancelar una factura impagada. Generar un extracto del cliente.
Última verificación. 7 de mayo, en la versión 14.2, por un miembro del equipo de soporte siguiendo estos pasos desde el principio.
Copia hasta aquí.
Ten en cuenta que la sección de supuestos duplica información que también está en la página de permisos. Esa duplicación es deliberada y es el punto.
Ejemplo de guía de usuario: ciento doce páginas que necesitaban otra página
Marlbury Systems suministra software de gestión de clínicas a unas cuatro mil quinientas prácticas veterinarias. Su guía de usuario llegó a ciento ochenta páginas, publicada en línea, estructurada como un manual: empezar, clientes y pacientes, citas, clínico, facturación, informes, administración.
Era completa, precisa y estaba bien redactada. La había producido un redactor técnico que conocía bien el producto.
Dos cifras de las analíticas iniciaron la investigación. El setenta y ocho por ciento de las visitas llegaba directamente a una página profunda, desde un motor de búsqueda o desde el enlace de ayuda dentro del producto. Y el tiempo medio en página era de catorce segundos.
Catorce segundos no es leer. Es llegar, escanear y salir.
El equipo de soporte aportó la otra mitad de la imagen. Las cinco páginas de ayuda más visitadas generaron más tickets que cualquiera de las demás, lo cual es lo contrario de para qué sirve una página de ayuda.
Alguien auditó la guía con una sola pregunta: ¿podría un lector que llega en frío a esta página completar la tarea?
Ciento doce de las ciento ochenta páginas contenían al menos una referencia que requería otra página. Como se describió arriba. Siguiendo desde la sección anterior. Usando el método del 5.2. Una vez que hayas completado la configuración del capítulo uno.
La página de reembolso, una de las más visitadas de toda la guía, se abría con una frase que remitía al lector a la sección anterior para saber cómo localizar una factura. La mayoría de las personas que la leían nunca habían visto la sección anterior y no tenían ninguna razón para saber que existía.
La reescritura no cambió ningún hecho. Los requisitos previos se reexpresaron en cada página en lugar de enlazarse. Las referencias posicionales se sustituyeron por instrucciones reales. Los títulos de las páginas se reescribieron según el registro de búsqueda del sitio, que mostraba que los usuarios buscaban reembolso mientras la página se titulaba reversión de nota de crédito. Cada página ganó un bloque corto de supuestos y dos siguientes pasos elegidos.
Cuatro meses después, el tiempo en página pasó de catorce segundos a setenta y uno. Los tickets que hacían referencia a los veinte temas principales bajaron aproximadamente un cuarenta y un por ciento. La proporción de usuarios que abrían en la ayuda dentro del producto y no contactaban posteriormente con soporte pasó del treinta y cuatro por ciento al cincuenta y ocho.
La guía se hizo más larga, porque los requisitos previos repetidos ocupan espacio. También se empezó a usar.
Cómo redactar una guía de usuario de software en seis pasos
Obtén la lista de páginas a partir de los datos de soporte y de búsqueda, no de la estructura del menú del producto. Los tickets te dicen lo que la gente no puede hacer y el registro de búsqueda te dice qué palabras usan.
Escribe una página por tarea, titulada como la pregunta. Si un título contiene un nombre de función que tus usuarios no dirían en voz alta, cámbialo.
Escribe primero el bloque de supuestos, antes de los pasos. Es la sección que evita que alguien pierda cinco minutos en la página equivocada.
Redacta los pasos realizándolos, no desde la memoria. Cualquier cosa que hagas automáticamente, de lo contrario, faltará.
Obtén los problemas comunes de la cola de tickets. Tres reales superan a diez imaginados.
Prueba llegando en frío. Abre la página como lo haría un desconocido e intenta completar la tarea sin abrir nada más.
El paso uno es lo que separa una guía organizada en torno a los usuarios de una organizada en torno al software. La estructura del menú del producto es un mapa de cómo se construyó el software. No es un mapa de lo que la gente intenta hacer.
Cómo nombrar páginas para que la gente las encuentre
Los títulos importan más en una guía de usuario que en casi cualquier otro documento, porque la búsqueda es el punto de entrada principal y el título concentra la mayor parte del peso de la coincidencia.
Tres reglas.
Usa la palabra del usuario, no la tuya. Si tu registro de búsqueda muestra que la gente escribe reembolso y tu página dice reversión de nota de crédito, la página es invisible para ellos. Revisa el registro. Es la investigación más barata disponible y la mayoría de los equipos nunca la abren.
Empieza con el verbo. Cómo reembolsar a un cliente. No: reembolsos de clientes, descripción general de. El verbo primero coincide con cómo preguntan las personas y se lee más rápido en una lista de resultados.
Una tarea por título. Una página titulada gestión de la facturación lo cubre todo y no coincide con nada. Divídela.
Cuando un término interno sea realmente el correcto, porque aparece en la interfaz, coloca la palabra del usuario en la primera línea de la página para que siga siendo localizable. Estás optimizando para dos audiencias a la vez: el motor de búsqueda y la persona que escanea los resultados.
Capturas de pantalla y el problema de mantenimiento
Las capturas de pantalla ayudan sobre todo donde el reconocimiento supera a la descripción: identificar un control entre muchos, mostrar una pantalla poco familiar, confirmar cómo se ve un resultado satisfactorio.
También son la mayor carga de mantenimiento en una guía de usuario. Una guía con doscientas capturas de pantalla es una guía con doscientas cosas que se rompen en silencio la próxima vez que cambie la interfaz, y las interfaces cambian cada pocas semanas.
Tres reglas mantienen el coste proporcionado.
Úsalas donde sea difícil nombrar y omítelas donde la instrucción sea clara por sí sola. Una captura de pantalla de un botón etiquetado Guardar no aporta nada.
Anota directamente en lugar de describir dónde mirar en el texto. Una captura de pantalla sin marcar de una pantalla ocupada es un rompecabezas.
Fechalas y conoce qué versión del producto muestran, para que el lector pueda saber si lo que está viendo todavía existe.
La postura honesta es que la mayoría de los equipos empiezan con buenas intenciones sobre la documentación visual y terminan con texto, porque el coste de recuperar después de cada lanzamiento supera el tiempo disponible. Ese es un problema de producción, no de voluntad, y se aborda más abajo.
Guía de usuario, manual de usuario o guía de cómo hacerlo?
Tres términos superpuestos, y las distinciones son útiles al elegir una estructura.
Una guía de usuario cubre un producto de software a través de las tareas que realizan sus usuarios. Varias páginas, introducidas en cualquier punto, mantenidas continuamente.
Un manual de usuario es lo mismo en la tradición más antigua, con forma de documento, y el término sigue siendo estándar para productos físicos y para software entregado on premise. Cuando un manual acompaña a un equipo físico, el contenido de seguridad y la colocación de advertencias conllevan obligaciones que las guías de software no tienen, y la tradición del manual de instrucciones cubre ese terreno.
Una guía de cómo hacerlo es una sola tarea, independiente, y esencialmente una única página de una guía de usuario publicada por sí sola.
La implicación práctica es que, si escribes cada página para que se mantenga por sí sola, como se argumentó arriba, tu guía de usuario ya es una colección de guías de cómo hacerlo con navegación por encima, que es la arquitectura correcta para la ayuda en línea.
Una guía de referencia rápida es diferente de nuevo: una hoja de consulta para alguien que ya está formado, cubierta en la página de guía de referencia rápida.
Lo que una plantilla gratuita de guía de usuario de software no puede arreglar
Una guía estructurada en torno al producto. Ninguna plantilla convierte una guía organizada por funciones en una organizada por tareas. Para eso necesitas los datos de soporte y de búsqueda.
Páginas que nadie puede encontrar. Una página bien redactada con el título incorrecto es invisible. Los títulos son lo más barato de arreglar y lo menos revisitado.
Capturas de pantalla que nadie mantiene. Ninguna descarga gratuita de plantillas de guía de usuario de software y ninguna descarga gratuita de plantillas de manual de usuario recuperará doscientas imágenes después de un rediseño.
Un producto que requiere tanta orientación. Si una tarea realmente necesita catorce pasos y tres advertencias, la documentación está haciendo el trabajo que la interfaz debería estar haciendo. Escríbelo de todos modos y pasa la observación a quien sea responsable del producto.
Muestra la tarea en lugar de describirla
Una guía de usuario es el tipo de documento con el mayor requisito de imágenes y el mayor coste de mantenimiento de imágenes, y esos dos hechos juntos explican por qué tantas guías son peores de lo que sus autores pretendían.
La aritmética es implacable. Una guía de cien páginas con tres imágenes por página son trescientas capturas, recortes, anotaciones y colocaciones. Después de un rediseño, son trescientas de nuevo. Nadie tiene ese tiempo en una semana de lanzamiento, así que las imágenes se vuelven obsoletas, y las imágenes obsoletas son peores que ninguna porque los lectores confían en ellas.
Trupeer AI cambia la base de costes. Alguien realiza la tarea una vez mientras graba, y el resultado es una página escrita paso a paso con capturas de pantalla ya capturadas, anotadas y colocadas, junto con un vídeo corto, en tu propia marca. Una página que tardaba una tarde se convierte en minutos, y volver a capturar después de un rediseño significa volver a grabar en lugar de volver a filmar.
Grábalo. Ponle marca. Tradúcelo. Trupeer it.
Hay dos puntos adicionales que importan específicamente para las guías de usuario. El vídeo se sitúa en la página junto a los pasos escritos, lo que sirve tanto para el lector que quiere escanear como para el lector que quiere ver, y esas son personas realmente distintas, no la misma persona en momentos diferentes. Y cuando tus usuarios abarcan varios idiomas, la misma grabación produce la misma página en cada uno, así que una guía traducida una vez no se desvía del producto mientras la versión en inglés mantiene el ritmo.
El material se guarda en tu base de conocimiento y también sirve como formación para el personal de soporte, que con frecuencia es el usuario más intensivo de una guía de usuario. La coherencia entre tus documentos es cuestión de configurar el kit de marca una vez, y la configuración se cubre en la guía de configuración de plantillas de documentos.
Preguntas frecuentes
¿Hay una versión Word gratuita de una plantilla de guía de usuario de software?
Word se adapta a una guía entregada como documento, lo que aplica a software on premise, productos regulados donde se requiere un manual con versión y a cualquier cosa que se entregue contractualmente. Un archivo Word de plantilla de guía de usuario de software funciona bien para esos casos.
Para software con un sitio de ayuda, funciona mal. Los usuarios llegan mediante búsqueda, necesitan que cada página sea direccionable y un documento Word produce un archivo largo sin un punto de entrada por página. Si estás publicando en línea, usa un sistema de documentación y mantén Word para el entregable con versión.
¿Hay una versión gratuita de plantilla de guía de usuario paso a paso en Word?
Sí, y la estructura de arriba se pega directamente en una sola. Crea el diseño gratuito de la plantilla de guía de usuario paso a paso en Word con una tarea por sección, pasos numerados de una acción cada uno y una línea de supuestos en la parte superior de cada sección.
Mantén las secciones lo bastante cortas como para que se mantengan por sí solas. El fallo más común en una guía basada en Word es una sección que solo tiene sentido después de la anterior, que es invisible en un documento y fatal cuando el mismo contenido se publica en línea.
¿Hay una versión PPT gratuita de una plantilla de guía de usuario de software?
Las diapositivas se adaptan a formación derivada de una guía, en lugar de a la guía en sí. Un mazo PPT de plantilla gratuita de guía de usuario de software es un formato razonable para una sesión de recorrido o un webinar de incorporación.
No lo uses como referencia. Las diapositivas no se pueden buscar de la forma en que los usuarios lo necesitan, no se pueden enlazar desde dentro del producto y, si se lee un mazo en solitario, falta la narración que aporta la mayor parte de su significado.
¿Hay una versión Excel gratuita de una plantilla de guía de usuario de software?
Excel no es un formato de guía y es realmente útil junto a una. Un archivo Excel de plantilla gratuita de guía de usuario de software funciona bien como inventario de contenido: una fila por página, con su título, responsable, fecha de verificación más reciente, versión del producto, vistas mensuales y volumen de tickets asociado.
Ese inventario es lo que te dice qué páginas arreglar primero. Las páginas con mucho tráfico y mucho volumen de tickets asociado son las que fallan, y sin el inventario arreglarás la página sobre la que alguien se quejó más recientemente.
¿Hay una descarga gratuita de plantilla de guía de usuario de software que merezca la pena usar?
La estructura de la página tarda veinte minutos en crearse, así que una descarga gratuita de plantilla de guía de usuario de software ahorra poco, y la mayoría de las plantillas publicadas tienen forma de libros con una página de contenidos y capítulos numerados.
Adoptar esa forma es el error contra el que argumenta esta página. Si usas una, elimina la numeración de capítulos y haz que cada página sea autosuficiente, lo cual es un cambio en cómo escribes, no en el archivo.
¿Un archivo Word de plantilla de manual de usuario es lo mismo?
En general, sí, con una diferencia de tradición más que de contenido. Un archivo Word de plantilla de manual de usuario proviene de la línea de los manuales impresos, así que asume lectura secuencial, una página de contenidos y números de página.
Eso funciona para un documento que realmente se leerá como documento, incluidos entregables regulados y manuales que acompañan a equipos físicos. Para la ayuda en línea de software, las suposiciones que hay detrás son la fuente del problema descrito en esta página.
¿Dónde puedo conseguir una descarga gratuita de plantilla de manual de usuario?
Está ampliamente disponible y, en su mayor parte, es intercambiable, porque una lista numerada de tareas no es un diseño difícil. Una descarga gratuita de plantilla de manual de usuario te dará una página de contenidos, encabezados de capítulo y una estructura de página.
Los dos cambios que merece la pena hacer en cualquiera de ellas son un bloque de supuestos en la parte superior de cada sección y la eliminación de todas las referencias cruzadas posicionales. Esos dos cambios llevan una hora en una guía existente y valen más que cambiar la plantilla.
¿Cuál es la mejor plantilla gratuita de guía de usuario de software?
La mejor plantilla gratuita de guía de usuario de software es la que trata la página en lugar del libro como la unidad, y casi ninguna lo hace.
Si estás comparando opciones, revisa una cosa: ¿la plantilla tiene un lugar en cada página para registrar lo que se asume que el lector ya ha hecho? Ese único campo es lo que hace que una página sobreviva a llegar a ella desde una búsqueda, que es como llegará la gran mayoría de tus lectores.
