Saltar al contenido
Engineer
Menú
Diseño
Español

Engineer / Portafolio

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.

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.

Contacto

¿Aún está definiendo lo que necesita?

Cuéntenos qué está fallando o qué intenta construir. Le diremos qué haría falta, cuánto costaría aproximadamente y si somos las personas adecuadas.

Desde 1.400 DKK por hora, sin IVA; y un precio por hora menor en una contratación más larga.

welcome@engineer.company +45 50 10 61 84 Copenhague, Dinamarca