Deja de sobreexplicar tu código
El post de Aksel Mo sobre descripciones de código es un recordatorio tranquilo de que estamos complicando algo simple. La idea central: cuando escribas sobre código, di lo que hace. No lo engalanes con frameworks, patrones o buzzwords. El inglés plano funciona.
Esto aterriza diferente a la mayoría del tech writing porque no se trata de construir algo nuevo — se trata de escribir sobre lo que ya construiste. Demasiados ingenieros escriben como si estuvieran haciendo pitch a inversores: microservicios, APIs, stacks, pipelines. El código se queda igual. La descripción se hace más pesada.
Por qué nos importa: Los ingenieros Brown y Black que programamos en inglés como segundo idioma ya hacemos trabajo extra — no necesitamos complicarnos más con la descripción.
Layout sugerido: estándar
“El código se queda igual. La descripción se hace más pesada.”