La documentación de tus sistemas

El otro día surgió la cuestión de que alguien más iba a dar mantenimiento a algunos sistemas de los que me he encargado desde hace años. Por lo que necesitaba entregar documentación y capacitar a la persona. Lo primero nunca se materializó pero generé la documentación y al hacerlo aprendí varias cosas.

No sos eterno y algún día alguien más va a continuar tu trabajo. Sea porque te despidan, renunciés o te muevan de responsabilidades ya no vas a darle mantenimiento a ese sistema que sólo vos sabés como entrarle por las idiosincracias propias o por la edad del sistema.

No podés recordar todo. Aunque manejés todos tus sistemas a diario sos un ser imperfecto, tu memoria va a fallar y cuando ocurra un imprevisto o tengás que cambiar algo en el sistema no vas a recordar qué comando hacía aquello o en que directorio estaban tales archivos. Dejando eso plasmado en la documentación te ayudará a no tener que recordar los detalles de las cosas cuando las necesités hacer.

Es un requerimiento legal. Depende de donde trabajés necesitás tener manuales de procedimientos, guías, instructivos etc. Si tienen una certificación de la calidad o en el sistema de gestión que use la institución por lo general se necesita que exista documentación.

No todo estaba tan bien como pensabas. Si, resulta que no sos tan listo como te creías y esa configuración de la cual tanto fanfarroneás no hace todo lo que se necesita o ese proceso automático no está en sintonía con los recursos de red a los que se necesita conectar.

Tu legado es transitorio. Sea que el sistema haya sido programado por vos o no en la mayoría de instituciones se adoptan las nuevas tendencias casi siempre sólo porque son nuevas y esto hace que el reemplazo del sistema se a inevitable y para eso se debe saber cómo funciona lo viejo para que entre lo nuevo.

El sistema crece y tu responsabilidad también. Es más, crece tanto que ya no te das a basto y otra persona te debe ayudar para monitorear y dar mantenimiento. Por lo general los sistemas crecen desordenados y eso es causa de otro montón de problemas.

No trabajás para la compañía tecnológica del momento. O tal vez si, no lo sé, pero en mi caso no lo es y si sos como yo entonces todos tus procesos no están debidamente identificados y tus manuales actualizados automáticamente. Hay que hacerlo de forma manual lo cual lo hace algo trabajoso pero necesario.

Sin duda es importante contar con documentación actualizada por su utilidad con vistas al pasado, presente y futuro, de ésta manera sabés (u otra persona) que se debe hacer en cualquier momento que haya que realizar un cambio. También me gusta pensar que contar con documentos útiles, claros y concisos demuestra que sos ordenado con tu trabajo y sos sistemático en su realización.


Creado: 2018-05-21

Actualizado: 2018-05-21