Documentación visual
Qué es la documentación visual, cómo encajan las capturas de pantalla en los flujos de documentación y los errores comunes.
La documentación visual es documentación que explica un producto, un proceso o un sistema sobre todo con imágenes: capturas anotadas, diagramas, videos cortos y secuencias de imágenes paso a paso, con apoyo de texto breve. Muestra al lector cómo debe verse la pantalla en cada paso, en lugar de limitarse a describirlo.
Las formas habituales incluyen guías prácticas, material de incorporación, procedimientos operativos estándar, notas de versión, informes de errores y presentaciones de formación. Las capturas de pantalla son el elemento más común, porque coinciden exactamente con lo que ve el usuario. Los diagramas explican la estructura, y los videos cortos o los GIF muestran el movimiento que las imágenes fijas no pueden mostrar.
Por qué importa la documentación visual
Los lectores escanean antes de leer. Una captura con un marcador numerado sobre el botón correcto confirma que están en el lugar adecuado y reduce los errores. Las guías visuales también salvan mejor las barreras del idioma que un texto largo, y reducen las preguntas repetidas de soporte sobre dónde está una opción.
Dónde se usa la documentación visual
- Centros de ayuda y bases de conocimiento.
- Procedimientos internos de los equipos de soporte, finanzas y operaciones.
- Documentación para desarrolladores que muestra pantallas de configuración.
- Informes de QA y tickets de errores.
- Formación para nuevos empleados.
Capturas de pantalla en los flujos de documentación
- Captura cada paso, idealmente una captura por acción.
- Recorta o enmarca la imagen en la zona relevante.
- Añade números de paso, flechas y etiquetas breves.
- Difumina los datos privados.
- Exporta como PDF o como imágenes web y publica.
Action Capture de Temposhot (Command+3) guarda el destino justo antes de cada clic aceptado y puede titular los pasos a partir del elemento en el que se hizo clic, usando Click "[[element-name]]" de forma predeterminada. El editor de Documents añade Step Numbers y encuadre, y la exportación genera PDF o imágenes por página.
Errores comunes
- Capturas que muestran toda la pantalla cuando solo importa un panel.
- Imágenes desactualizadas después de un cambio en la interfaz.
- Tamaños y estilos de anotación inconsistentes entre pasos.
- Datos privados que quedan en las imágenes publicadas.
¿Tomas las mismas capturas una y otra vez?
Graba un procedimiento una vez con Action Capture y edítalo en Documents. Consulta Action Capture.
Preguntas frecuentes
¿Cuántas capturas debe tener una guía?
Una por acción que cambie la pantalla es un buen punto de partida. Omite los pasos que no necesitan imagen.
¿Cómo mantengo las capturas actualizadas?
Vuelve a capturar los pasos afectados después de cada cambio en la interfaz y conserva los originales de cada versión.
Fuentes
Recursos relacionados
- Guía de Action Capture: crea guías paso a paso a partir de clics.
- Anotaciones y encuadre: números de paso y foco.
- Exportación de Documents: exportaciones a PDF e imágenes por página.
¿Repites las mismas capturas de pantalla una y otra vez?
Temposhot captura una pantalla, una ventana o un área con temporizador y exporta el conjunto como PDF, imágenes, ZIP o MP4. Las herramientas gratuitas para navegador solo sirven para imágenes sueltas.
Recursos relacionados
Términos relacionados
- Anotación de capturasUna captura anotada usa flechas, etiquetas, recuadros, resaltados o difuminado para mostrar lo importante. Compara los tipos de marcado habituales y los errores que conviene evitar.
- Flujo de trabajo con capturas de pantallaQué es un flujo de trabajo con capturas de pantalla y cómo crear un proceso repetible desde la captura hasta la entrega.
- Capturas de pantalla a PDFCómo convertir capturas de pantalla en PDF, cuándo usar exportaciones de una o varias páginas y los errores que conviene evitar.
- Captura de antes y despuésCómo funcionan los pares de capturas de antes y después, dónde se usan y cómo crear comparaciones eficaces.
- Difuminado de privacidadQué es el difuminado de privacidad, en qué se diferencia de la redacción y cómo difuminar información sensible en capturas de pantalla.