Documinding

Esta idea la introduje en la charla que dí en la WebConf Latam 2022, pero es algo que venimos trabajando desde hace un tiempo.

El objetivo es asegurar una cantidad de documentación necesaria, pero mínima.

¿Cómo?

Lo primero es hacer un análisis de riesgo de las tareas que tenemos más arriba en el backlog. No el clásico análisis de riesgo... simplemente identificar las tareas riesgosas desde lo técnico o del negocio.

Con esa lista, documentar las tareas más riesgosas usando uno o varios de los siguientes formatos, en orden de prioridad:

• Status Quo en el ticket  (If in JIRA it is not, exist it does not!). -Yoda ^jira
• Código autodocumentado (no solo Clean Code)
• README.md actualizados, concretos y completos
• Ejemplos (técnicos y de negocio) en Notion o similar.
• Casos de prueba
• Diagramas (Notion o diagram as code con Mermaid que tiene integración nativa con GitHub)
• Narrativa en Notion

Significant Revisions

Nov 24, 2022: Original publication on dariomac.com