La documentación. Parte 2

La documentación, de ella ya escribí hace bastante tiempo aquí , los que me conocen y los que trabajan o han trabajado conmigo saben que es de obligado cumplimiento el documentar y mantener la documentación actualizada, no se debería consentir ni como proveedor ni como cliente, que no exista una documentación relacionada con los servicios implicados, en nuestro sector es más que necesario que todo esté correctamente documentado y aún así sigo viendo barbaridades de todo tipo, no sería la primera vez que se va a un cliente nuevo y al llegar te encuentras con una mano delante y una detrás, que el informático anterior no tiene documentado nada, que el cliente solo sabe que paga y ya está, sin tener un registro de averías o incidencias, ni direccionamiento, ni si trabaja en dominio o no, o simplemente saber cuántos servidores tiene o qué servicios o aplicaciones tiene en su red, la verdad es que a menudo me encuentro en unos <<salaos la mar de divertidos>>, evidentemente no es lo mismo ir a una oficina con unos pocos ordenadores y un servidor, a cuando vas a un cliente medio o grande con varias oficinas repartidas por el mundo o por el país o por tu ciudad, da igual, el denominador común es siempre el mismo: documentación inexistente, desfasada, incompleta, lo que se resume como DEJADEZ.

Ya comenté las típicas razones de porque no se documenta en el post comentado anteriormente y sigo escuchando las mismas excusas, muchos compañeros de profesión por activa y por pasiva me han replicado e intentado hacer ver que dichas excusas son motivos más que suficientes para no documentar o hacer lo mínimo. En el presente post intentaré animar y hacer ver a todos los navegantes que me lean inciso en lo mismo de siempre, DA IGUAL que seas administrador de proyectos, desarrollador, que estés en una helpdesk de soporte a usuarios, que seas un administrador de sistemas o de red de nivel mega dios, seas perito informático, pentester, técnico de campo, lo que sea, “documentad insensatos”.

Siempre pongo el ejemplo del perito, que documenta todos los pasos realizados en su trabajo, toma notas y realiza informes y dictámenes que demuestran que se ha realizado el trabajo encomendado de forma correcta y manteniendo unas garantías, ¿porque no lo hacen los demás?.

El tema que parece que en mi antiguo post me faltó detallar un poco más, y en el que más se escuda el mundo es FALTA DE TIEMPO, paremos un momento aquí, volvamos al ejemplo anterior, el que a estado desarrollando el trabajo anterior “perito informático” no será la primera vez que vienen con un caso para dentro de 3 días, o 2 días y tiene que realizarlo en tiempo récord, estresado y sin dormir, aún así minuciosamente documenta su trabajo, analiza y desarrolla para que todo el trabajo realizado no vaya al traste, ¿que es lo que diferencia ese trabajo del resto? ¿que no hay que ir a juicio?, a ver seamos serios. Tal vez el problema está en que no se le da importancia que requiere, tal vez es que esperamos a acabar para luego documentar, <<desde mi punto de vista, hacemos un flaco favor a nuestro trabajo y a nuestro tiempo>>, ¿porque no documentamos conforme vamos haciendo el trabajo? además de que nos sirve para mantener el foco en la tarea que tenemos entre manos, nos puede ayudar a repetir pasos o evitar repetir lo que ya hemos realizado, acordarnos de ese comando con el que nos hemos estado peleando durante un rato hasta que hemos conseguido lo que queríamos hacer y luego añadirlo a un script, o simplemente tenerlo como referencia por si alguna vez necesitamos hacer lo mismo en otro sitio, o si estamos haciendo un script que llama a un módulo <<evidentemente en este ejemplo estoy hablando de powershell>>, documentar de donde lo hemos descargado o quién lo ha desarrollado y para qué es y porqué lo llamamos desde nuestro script, nos facilitará que si en unos meses tenemos que revisarlo o un compañero tiene que tocar ese script sepa por dónde le vienen los tiros (lo que repercute en la productividad de tu compañero y en la tuya propia ya que tu compañero no te tiene que estar interrumpiendo lo que estés haciendo para explicarle “si te acuerdas” de cómo iba o qué hacía). Esto no es solo para temas de scripting o desarrollo en general, documentar en una empresa como se realizan las copias de seguridad, donde se almacenan, qué software se utiliza, donde está dicho software, si tiene licencia, que tipo de licencia es y el procedimiento utilizado para realizar las copias, si están automatizadas, cada cuanto se comprueba que se están haciendo correctamente, viendo su importancia no deberíamos considerarlo un tema baladí ¿verdad?, y eso que estamos hablando en este ejemplo de las copias de seguridad, uno de los grandes pilares (evidentemente desde mi humilde punto de vista) , para todo el mundo; empresas y particulares.

Sí, ya sé que documentar es aburrido y consume tiempo, es más guay trastear y cacharrear que sentarnos a escribir, aquí hoy “rompo la lanza” a favor de la documentación.

Por cierto, tened presente que en algunos casos, podemos encontrarnos pequeños trucos para automatizar un poco la documentación, scripts, aplicaciones que extraen información del equipo, de la red, etc. También podemos encontrar que si estamos probando comandos en powershell podemos usar el cmdlet start-transcript del cual ya hice referencia en este post . En bash tenemos el comando script , si estamos trabajando con windows tenemos psr (grabación de acciones de usuario), como digo siempre <<cada maestrillo con su librillo>>, cuando os sea posible automatizad la documentación, utilizad lo que os sea más cómodo y se adapte a vuestras necesidades (un simple fichero de texto, un word, un excel, un wiki, un sharepoint, evernote, etc.) PERO DOCUMENTAD INSENSATOS.   🙂

Después de haber leído el primer post y este, ¿piensas realmente que no es necesario documentar? ¿que no hay tiempo? ¿que no sirve para nada? reflexionad un poco y empezad a documentar, algún día me lo agradeceréis.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.