Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt

Use this file to discover all available pages before exploring further.

Esta página explica las mejores prácticas para usar capturas de pantalla, GIFs y videos en tu documentación.
Las capturas de pantalla, los GIFs y los videos pueden mejorar la documentación, pero requieren mantenimiento continuo a medida que cambian los elementos de la interfaz. Úsalos de forma selectiva para evitar trabajo de mantenimiento innecesario. Pautas clave:
  • El contenido multimedia debe ser complementario. Si un flujo de trabajo es claro solo con texto, evita agregar elementos visuales.
  • Garantiza la accesibilidad. Agrega texto alternativo a las imágenes, subtítulos a los videos y transcripciones al contenido de audio. Muchas personas usan tecnologías de asistencia, y el contenido accesible beneficia a todos los usuarios.
  • Equilibra claridad y mantenimiento. Los cambios frecuentes en la interfaz pueden volver obsoletas las capturas de pantalla y los videos rápidamente. Considera si el esfuerzo de actualizarlos compensa el valor que aportan.

​
Cuándo usar contenido multimedia

  • Capturas de pantalla para tareas difíciles de explicar con palabras.
  • GIF para fines promocionales y flujos de trabajo cortos pero complejos.
  • Vídeos para conceptos abstractos y flujos de trabajo largos.
Utiliza el contenido multimedia con moderación y de forma intencionada para evitar deuda de documentación innecesaria. Bien aplicado, mejora la comprensión sin añadir cargas de mantenimiento ni barreras de accesibilidad.