50.000 palabras de documentación de software
Redacté 50.000 palabras de documentación completa del software con
Markdown en GitHub, Craft y Confluence, preservando el conocimiento
y la transparencia del proceso.
2022 – 2024

Situación. La mayor parte del conocimiento importante del producto y
de la forma de trabajar estaba en la memoria de las personas. Eso
funciona hasta que alguien se incorpora o se marcha; entonces la
incorporación se ralentiza y basta una dimisión para perder
definitivamente parte de la memoria de la organización.

Tarea. El objetivo era trasladar ese conocimiento a documentación
que las personas conservaran y utilizaran: suficientemente clara
para leerla y estructurada para mantenerla, sin abandonarla al cabo
de un mes.

Acción. Se redactó gran parte a mano, unas 50.000 palabras al
terminar, en Markdown repartido entre GitHub, Craft y Confluence
según correspondía. Se cubrieron la arquitectura, los procesos y las
instrucciones prácticas, es decir, las preguntas recurrentes. La
documentación quedó bajo control de versiones y, con la misma
importancia, fácil de encontrar: una documentación que nadie puede
localizar es como si no existiera.

Resultado. El conocimiento dejó de ser frágil. Las nuevas
incorporaciones avanzaron más rápido, los procesos pasaron a poder
consultarse en lugar de reconstruirse de memoria y el conjunto se
volvió auditable: era posible ver cómo y por qué se trabajaba en
lugar de tener que aceptarlo por confianza.

Categorías:
1Dirección de equipos	/es/categories/team-leadership/	engineer.company	70
1Dirección técnica	/es/categories/technical-leadership/	engineer.company	70
1Mentoría y acompañamiento	/es/categories/mentoring/	engineer.company	70
1Documentación	/es/categories/documentation/	engineer.company	70

Servicios:
1Dirección técnica y consultoría	/es/services/technical-leadership/	engineer.company	70
1Documentación técnica	/es/services/technical-documentation/	engineer.company	70

hEsta página en la web	URL:https://engineer.company/es/portfolio/wrote-50000-words-of-software-documentation/	engineer.company	70
