La documentación es la otra mitad de un tutorial
Hay quien ve el vídeo, hay quien lo lee por encima, y los buscadores indexan las palabras. Producir un vídeo y una guía escrita por separado significa escribir el mismo recorrido dos veces. Capture ya entiende tu tutorial lo bastante bien como para limpiar su voz en off, así que la versión escrita sale del mismo trabajo.
Cómo funciona Generate guide
- Edita el tutorial como siempre. Los cortes y recortes se trasladan a la guía.
- Haz clic en Generate guide en el editor. Si el proyecto todavía no tiene transcripción, Capture lo transcribe primero.
- Capture redacta la guía a partir de la transcripción, preferiblemente la de tu voz en off optimizada, y de tus clics: un título, una introducción y pasos numerados.
- Cada paso tiene una captura de la grabación en el momento en que hiciste clic, además de un enlace para saltar a ese momento del vídeo.
Si cambias la edición más adelante, la guía se marca como desactualizada. Vuelve a generarla para ponerla al día.
Cómo escribir documentación de software cuando prefieres demostrarlo
Pregunta a cualquiera que mantenga un centro de ayuda qué hace lenta la documentación, y nunca es escribir. Es decidir el orden de los pasos, acordarte del requisito previo que tú te saltas sin pensar y describir una pantalla de memoria con la precisión suficiente para que la siga un desconocido.
Demostrar la tarea resuelve las tres cosas. Haces los pasos en el orden correcto porque el producto te obliga, el requisito previo aparece porque de verdad lo haces y la pantalla se describe con exactitud porque la grabación es la pantalla. Después, editas un borrador en lugar de enfrentarte a una página en blanco.
Una buena documentación sigue necesitando a una persona que decida qué importa. Lo que no necesita es a alguien transcribiendo sus propios clics.
Dónde encaja en Braiv Capture
Las guías son una capacidad complementaria de Braiv Capture, construida sobre la optimización de la voz en off. Las guías se redactan en el idioma original del tutorial. Para guías escritas a partir de vídeos que ya están en YouTube, consulta de vídeo de YouTube a artículo de soporte.
