Ubuntu TechHive
proposal.detail
Propuesta

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.

Intermedio · 2 horas · 4 de agosto de 2026 · 3 de junio de 2026

Descripción

section.description

Una 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.

support.yml

apoyo de miembros

1 apoyo

Miembros de la comunidad que quieren que este evento se realice.

Apoyar
Proponer
proposal.yml

Detalles de la propuesta

Estado
Propuesta
Dificultad
Intermedio
Duración
2 horas
Fecha objetivo
4 de agosto de 2026
Creada
3 de junio de 2026