Technical Documentation for Teams: READMEs, Runbooks, Diagrams, and Examples
Una sesión práctica de dos horas sobre documentación técnica para equipos, centrada en archivos README, manuales operativos (runbooks), diagramas y ejemplos. Los asistentes trabajarán en compromisos de ingeniería concretos, revisarán ejemplos y se llevarán una lista de verificación que pueden aplicar en proyectos reales de equipo.
Descripción
section.descriptionUna sesión práctica de dos horas sobre Documentación Técnica para Equipos, centrada en READMEs, Runbooks, Diagramas y Ejemplos. Los asistentes trabajarán con compromisos de ingeniería concretos, revisarán ejemplos y se llevarán una lista de verificación que podrán aplicar en proyectos reales de sus equipos.
Audiencia: desarrolladores de nivel inicial e intermedio que buscan una sesión de ingeniería práctica, no un recorrido por un lenguaje de programación.
Resultados:
- Explicar los límites prácticos de la Documentación Técnica para Equipos
- Aplicar READMEs en un pequeño ejemplo de trabajo
- Aplicar Runbooks en un pequeño ejemplo de trabajo
- Aplicar Diagramas en un pequeño ejemplo de trabajo
Formato: dos horas con una breve introducción, un ejemplo concreto, discusión sobre compromisos y una lista de verificación final para la práctica.