Documentación en video para proveedores de hardware y appliances, incluidos los sistemas aislados

Esto es para ti si

• Los ingenieros de campo o los clientes realizan pasos físicos de instalación, de sustitución o de firmware.
• El entorno está aislado, es clasificado o no tiene conexión por algún otro motivo.
• Tienes fotografías de ingeniería, diagramas de rack o un manual a partir de los cuales podemos trabajar.
• La rotación en el servicio de campo hace que el mismo procedimiento se enseñe una y otra vez.

No es para ti si

• No hay nada a partir de lo cual trabajar: ni manual, ni fotografías, ni un procedimiento escrito en ningún sitio.
• Necesitas un equipo de rodaje in situ con tu hardware. Eso es trabajo de una agencia.

Qué es el modo Renderizado con diapositivas

Es un montaje narrado a partir del material de origen: la secuencia de pasos tal como se realizaron, las fotografías de cada estado, las figuras del propio manual, con la versión y la fecha en pantalla. No es una grabación de pantalla y nunca se describe como tal. Solo el modo Operación en vivo produce un paso a paso verificado, y mantenemos esa distinción en los textos de todas las páginas.

Lo que sí comparte con una ejecución en vivo es la disciplina: una tarea, requisitos previos indicados, un estado final que se puede señalar, y los pasos que salen mal, que se conservan en lugar de disimularse.

Sistemas aislados

En los sistemas aislados, la ejecución se hace in situ, en la máquina aislada, y el video se monta después a partir del registro y las fotografías. Nada sale del entorno salvo el registro de lo que se hizo, que tu equipo revisa antes de que se publique nada.

Dónde compensa

• Procedimientos de sustitución que un ingeniero de campo realiza una vez al año y vuelve a aprender cada vez.
• Secuencias de actualización de firmware en las que todo el riesgo está en el orden de las operaciones.
• Procedimientos de montaje en rack, cableado y encendido que se entregan con el appliance, en el idioma del cliente.

Preguntas

¿Un video en modo Renderizado con diapositivas está verificado?

No, y no lo llamaremos así. Solo el modo Operación en vivo produce un paso a paso verificado. El modo Renderizado con diapositivas se construye a partir del registro de ejecución, fotografías y el manual, y la página lo dice.

¿Qué se necesita de nuestra parte para empezar?

El procedimiento tal como está escrito ahora, fotografías o diagramas de cada estado y alguien que pueda confirmar el orden de las operaciones. Si hubo una ejecución real, su registro.