Documentación técnica (Docs-as-Code)

Curso práctico para integrar la documentación técnica en el ciclo de trabajo como disciplina de ingeniería: producir artefactos accionables y verificables (README, mini‑specs, Design Doc Lite, ADRs y runbooks) alojados en repositorio, revisados vía PR y mantenidos como fuente única de verdad. El curso combina teoría breve, plantillas y un laboratorio final donde los participantes entregan un PR con checklist Doc Done.

Al finalizar el curso, el participante será capaz de:

• Convertir conocimiento disperso en documentación accionable con verificación y evidencias de pruebas
• Definir y aplicar una política de source of truth (repo vs wiki) y reglas mínimas de revisión
• Redactar Markdown profesional para repositorio: estructura, tablas, checklists y navegación interna
• Escribir una mini‑spec de feature con criterios de aceptación verificables (Given/When/Then) y plan de pruebas
• Documentar diseños técnicos con Design Doc Lite y registrar decisiones mediante ADRs incluyendo trade‑offs
• Crear documentación operativa: README útil, runbook seguro con rollback y reglas de mantenimiento
• Aplicar la checklist Doc Done y completar un PR con artefactos mínimos como criterio de aprobación

1. Fundamentos y política de documentación: propósito, audiencia, source of truth, definición de Doc Done y ownership
2. Markdown profesional: patrones repo‑ready, README template, tablas, checklists y navegación interna
3. Design Doc Lite y ADRs: estructura, cuándo documentar, registrar decisiones y trade‑offs
4. Documentación operativa y runbooks: runbook seguro, rollback, manejo de secretos y caducidad
5. Diagramación y visuales (Mermaid): integración en Markdown, plantillas y modularización
6. Flujo de trabajo con Git para documentación: branching mínimo, PRs, plantillas de PR y checklist de revisión
7. Tooling y CI para documentación: linters, spellcheck, previews de PR y validación de diagramas
8. Laboratorio integrado: entrega práctica en repo (README + ADR + Runbook + diagrama) y PR con Doc Done checklist

Entregables y criterios de aprobación

• Plantillas entregadas: README, Design Doc Lite, ADR, Runbook, Doc Done checklist y PR template
• Criterio: PR con artefacto mínimo + checklist completado y revisión aprobatoria (merge o feedback actionable)

Plantillas incluidas

• README template
• Design Doc Lite template
• ADR template
• Runbook template
• Doc Done checklist
• PR template

• Capacidad de leer documentación técnica y seguir procedimientos: setup, verificación y troubleshooting