Explicación mecánica
Explicar el movimiento indexado a partir de una imagen de mecanismo
Prueba esto
“Usando @GenevaDrive, muestra cómo la rotación continua se convierte en un movimiento indexado preciso.”
Convierta documentos técnicos en videos tutoriales precisos
Cargar diagramas, manuales, notas de configuración, mapas de procesos y cartas técnicas para generar tutoriales que visualizan partes, condiciones, decisiones y relaciones de sistema.
Usar movimiento para hacer visible una relación del sistema
Tutorial técnico
Convertir una página de referencia HTTP en una lección sobre el ciclo de vida de las solicitudes
Prueba esto
“Usando Descripción general de HTTP de MDN, explica el ciclo de vida de la solicitud HTTP desde la configuración del cliente hasta la respuesta, el almacenamiento en caché y los límites de falla.”
El flujo de trabajo ilustrativo · Blueprint Breakdown
Guía de lanzamiento y arquitectura de Atlas Scheduler v3
Prueba esto
“Usando @Atlas Scheduler v3 Guía de arquitectura y lanzamiento, Convertir la fuente en una explicación clara de la ruptura de los planos para los desarrolladores y los comunicadores técnicos.”
Haga que el diseño complejo sea fácil de seguir
Vea por qué Burj Khalifa es tan alto
Prueba esto
“Usando @BurjKhalifa, muestra el plano en Y, el núcleo reforzado, los retrocesos contra el viento y la estera apilada.”
Haga que los equipos complejos sean fáciles de seguir
Mira como funciona una máquina de litografía, paso a paso
Prueba esto
“Usando @Litografía, explica el camino completo desde la exposición hasta la transferencia de patrones.”
Para quién es
Equipos técnicos y de ingeniería
Necesita un sistema o proceso que tenga sentido para alguien que no escribió la especificación original.
- Ingenieros
- Redactores técnicos
Documentos típicos:EspecificacionesDiagramasEquipos de habilitación y soporte
Quiere que una configuración o proceso complejo sea más fácil de revisar antes de que un cliente o compañero de equipo necesite ayuda.
- Equipos de habilitación
- Equipos de soporte
Documentos típicos:Guías de configuraciónMapas de procesos
Prepara tus documentos
Comience con la fuente en la que ya confía
Convierta un diagrama técnico, manual, especificación o nota de configuración en un video tutorial que facilite el seguimiento de los sistemas y procesos.
- Esquemas técnicos
- Manuales y especificaciones
- Notas de configuración
- Mapas de procesos
- Resúmenes del sistema
Antes de comenzar
- Utilice la versión fuente completa y actual
- Marque las secciones, pasos, gráficos o figuras que merecen atención
- Identifique los términos, números, advertencias o textos que deben permanecer
Un camino enfocado
Revelar la relación antes de la terminología
- 1
Nombre la pregunta del espectador
Indique la pregunta del sistema, la relación que debe ver un espectador y el nivel de detalle que coincide con su trabajo.
- 2
Trae la fuente que lleva los detalles
Agregar la fuente actual y nombrar las secciones, términos, figuras o pasos que debe preservar la explicación.
- 3
Refinar la explicación para su contexto de uso
Haga que el propietario técnico revise la terminología, los diagramas, los límites de seguridad y cualquier detalle específico de la versión antes de compartir el tutorial.
Siguiente paso útil
Utilice un recurso o caso que coincida con esta tarea
Utilice un script respaldado en código fuente para hacer visible una ruta técnica
Documentación técnica
Convierta la documentación técnica en videos claros
Una guía práctica para convertir guías de arquitectura, documentación para desarrolladores y runbooks de TI en vídeos explicativos técnicos claros.
Utilice este recurso Plantillas y listas de verificaciónPlantilla de guión explicativo de procesos complejos
Una plantilla de guión copiable de 60 segundos para explicar un proceso, decisión, gráfico o flujo de trabajo técnico con evidencia visual clara.
Utilice este recurso Plantilla de operaciones de TIPlantilla de Runbook de TI a vídeo
Una plantilla copiable para convertir un runbook de TI en un vídeo tranquilo y específico para cada función que aclara la primera comprobación, ruta y transferencia.
Utilice este recurso Caso respaldado por fuentesCómo convertir una guía de arquitectura de lanzamiento en un video de incorporación de desarrolladores
Vea cómo una guía de arquitectura y lanzamiento se convierte en un video de incorporación de desarrolladores que conecta componentes, flujo de lanzamiento y contexto de contribución.
Leer diseño de caso Caso respaldado por fuentesCómo convertir un runbook de incidentes de TI en un vídeo de clasificación tranquilo
Vea cómo un runbook sobre degradación de servicios de TI se convierte en un tranquilo vídeo de clasificación que muestra comprobaciones de estado, propiedad de escalamiento y la próxima actualización para los equipos de operaciones.
Leer diseño de caso