Guía del vídeo demo de producto para README

¿Cuándo debe un README usar un vídeo demo de producto?

Un vídeo demo de producto para README es preferible a un GIF corto cuando un lector del repositorio necesita una secuencia visible más completa de la que puede transmitir un bucle breve. La decisión depende de la pregunta técnica del lector, del movimiento necesario para responderla, y del anfitrión del repositorio donde se renderizará el activo. No es una afirmación de que el vídeo siempre sea mejor, de que todo README necesite movimiento, ni de que un formato funcione en todo repositorio.

GogoScreen empieza con la URL de una app web accesible y una indicación de una línea, y después devuelve un candidato en MP4 editado. Puede añadir voz en off ajustada a los eventos en pantalla, subtítulos, zooms en los clics, suavizado del cursor y cortes de los silencios muertos. Estos datos del flujo de trabajo hacen que un candidato en MP4 esté disponible para revisión. No establecen que un anfitrión lo insertará como se pretendía ni que un candidato concreto sea adecuado para la documentación del repositorio.

La guía del GIF demo para README ya cubre la elección de representación corta para un lector que escanea. Esta página responde a la pregunta de formato distinta: ¿cuándo necesita un lector vídeo porque la tarea visible, el detalle o la narración opcional requieren más que un bucle compacto?

Compare el vídeo y un GIF corto usando el mismo flujo

Use la misma secuencia revisada al comparar formatos. De otro modo la elección se convierte en una comparación de dos historias distintas en lugar de una decisión de formato real. Compruebe el primer fotograma, el detalle legible del producto, la acción, el resultado, el peso del archivo, el comportamiento de reproducción y la compatibilidad del anfitrión del repositorio. Un vídeo puede conservar más detalle o proporcionar orientación hablada opcional. Un GIF puede ser un ajuste más sencillo cuando la acción es obvia sin controles ni audio.

La guía del fotograma de portada del vídeo demo ayuda a seleccionar una primera imagen fiel para un espectador que nunca inicia la reproducción. La guía del vídeo demo de producto sin sonido comprueba si el flujo visible transmite su prueba principal sin audio. Estas revisiones importan antes de elegir vídeo porque un lector de README puede no pulsar reproducir ni escuchar la narración.

No describa GogoScreen como un generador de GIFs. Esta es una decisión de formato a partir de un activo de origen revisado. La guía de subtítulos para el vídeo demo de producto revisa palabras legibles que coincidan con los eventos visibles. La guía de voz en off para el vídeo demo de producto revisa la narración ajustada al mismo flujo de navegador.

Proteja la documentación y el límite privado

Mantenga el ejemplo del repositorio libre de material privado

No use aplicaciones de clientes, URLs de clientes, medios de clientes, nombres, credenciales ni material privado para hacer que un ejemplo de README resulte más convincente. Use un contexto controlado, sin clientes. Cuando se necesita iniciar sesión para un flujo seleccionado, se puede proporcionar una cuenta de demostración descartable mediante el proceso aprobado. Los redactores y revisores no solicitan, reciben, copian ni inspeccionan las credenciales. En GogoScreen, las credenciales se cifran, se usan para una única renderización y después se eliminan. Si primero se planifica un storyboard, las credenciales se conservan cifradas durante esa sesión y se eliminan como máximo dos horas después de su último uso.

Si la ruta, el acceso o el flujo seleccionado no son adecuados, cambie el elemento de preparación más pequeño antes de considerar otro candidato. La guía de fallo de renderización del vídeo demo ayuda a diagnosticar el problema. La guía de reintento del vídeo demo de producto registra el cambio de preparación para otro intento. Aproximadamente una de cada cinco renderizaciones falla o necesita un segundo intento, así que un archivo devuelto nunca debe tratarse como prueba de documentación automática.

Elija la audiencia del repositorio antes de otro canal

Para la distribución más allá del repositorio, la guía del vídeo demo de Show HN considera una audiencia de lanzamiento técnica, y la guía de vídeo de producto para página de destino considera a un visitante que evalúa una promesa de página. Esos son trabajos distintos a ayudar a alguien a inspeccionar un repositorio antes de la instalación.

Lea los precios, la información de privacidad y los términos antes de una solicitud. Visite el centro de guías para decisiones adyacentes. Un vídeo demo de producto para README merece su lugar cuando ayuda a un lector del repositorio a entender un flujo de trabajo funcionando mientras la documentación permanece completa sin él.