Syadmins: La mala documentación no es una estrategia de IE

Si cree que puede salirse con la suya con poca o ninguna documentación para siempre, siga leyendo. Este artículo disipa ese mito. Un administrador de sistemas que considera que la documentación es dolorosamente aburrida, o una pérdida de tiempo cuando hay tantos incendios que apagar, a menudo produce documentación de mala calidad. La falta de atención a los detalles, o su incapacidad para crear un producto escrito consistentemente reproducible, disminuye su seguridad laboral.

Índice

¿Qué es un documento?

Los administradores del sistema tienen la tarea de realizar una variedad de tareas divertidas y desafiantes a diario, y lo inevitable es la resolución de problemas. La documentación debe funcionar como un registro o historial de un evento o situación pasada. No hay más tiempo para una documentación adecuada y detallada que para la resolución de problemas.

Debe documentar tanto el análisis raíz/causa como los detalles más finos. Por ejemplo, si sufrió una avería de algún tipo, su investigación forense debe contener los síntomas, la inferencia y el razonamiento que llevaron a su diagnóstico, así como los pasos que siguió para resolver el problema, las personas involucradas, etc. un ticket se crea cada vez que ocurre un problema o incidente, por lo que es aquí donde se debe almacenar la información sobre el ticket.

Además, una buena documentación ayuda a la persona más importante en el proceso: usted. Estandariza los procesos y los hace repetibles. ¿Quién quiere que lo llamen el viernes por la noche mientras toma deliciosos tragos para ayudar a un miembro del equipo, cuando puede enviar a un administrador junior durante la noche para leer el wiki del proceso repetible y documentado que usó hace seis meses? ¿Y quién puede recordar lo que sucedió hace seis meses cuando tienes boletos llegando rápido y furiosamente en este momento?

Métodos de documentación

La documentación puede tomar diferentes formas: wikis, bases de conocimiento, un sistema de tickets, un repositorio de GitHub, Google Docs, etc. El objetivo de toda la documentación es ser completa, sucinta, precisa, legible por humanos y accionable. Su documentación debe ser reutilizable, especialmente al solucionar problemas, ya que el mismo problema podría ocurrirle a otro administrador del sistema en el futuro. Su documentación o rastro en papel debería permitirle a este administrador del sistema aplicar la información proporcionada y llegar a una resolución sin demasiada dificultad.

Suponga que durante otro incidente, se informó que un sistema no se iniciaría. Identifica los síntomas y desarrolla una hipótesis sobre la naturaleza del problema. Luego sigue los pasos uno, dos, tres y cuatro para solucionar el problema. Todos estos detalles deben documentarse, junto con su descubrimiento de que el disco duro tenía sectores defectuosos, por ejemplo. Puede poner esta información en el cuerpo del ticket o puede almacenarse, por ejemplo, en una base de conocimiento o wiki.

Mala documentación vs buena documentación

Tus emociones y sentimientos entran en la escritura, así que si odias el material de escritura y lo ves como una molestia, se notará en la calidad de tu escritura. Si no establece una buena relación con la escritura y la documentación, podría afectar negativamente su reputación y su trabajo.

El ejemplo número uno de documentación deficiente es la falta de documentación. Como administrador del sistema, la documentación es una tarea diaria. Si bien puede ser lo que menos le gusta, es una parte importante de su seguridad laboral. Otro ejemplo de documentación deficiente es la documentación que es difícil de seguir o vaga en su descripción o explicación. Si la documentación permite que alguien haga más preguntas o no responde las preguntas que se supone que debe responder, es una mala documentación.

La mala documentación también es confusa y frustrante. Construye silos y potencialmente paredes transversales. La documentación deficiente es tribal y conduce a cuellos de botella. Si su documentación es deficiente, se le pedirá que la reescriba y, para entonces, es posible que haya pasado por alto algunos detalles. ¿Por qué no hacerlo bien la primera vez? No hagas trabajo extra por ti mismo.

Escribir documentación también es una forma efectiva de pensar en los detalles críticos de un tema técnico. Como administrador del sistema, debe desarrollar una relación saludable con la documentación, ya que podría posicionarlo para promociones, nuevas oportunidades técnicas interesantes, publicaciones y más. Cuanto mejor sea su relación, mejor será la calidad de su documentación.

Uno de los beneficios de una buena o excelente documentación es que brinda ayuda a otra persona, ya sea su compañero de equipo, un cliente o tal vez alguien más, incluso su jefe. La buena documentación es transferible, perspicaz, clara y concisa. Aumenta las habilidades y reduce las brechas de conocimiento, y es más reutilizable y comprensible. Una buena documentación ayuda a resolver problemas e incluso a romper los silos.

Ancho de banda del documento

Si trabaja en una empresa u organización durante mucho tiempo, es probable que su documentación esté desactualizada. El tiempo que se retiene su documentación depende de la tasa de abandono de su entorno. Una forma de permitir que su documentación viaje es usar herramientas de administración de código fuente (SCM) como GitHub Donde GitLab. De esta manera, los cambios se pueden actualizar periódicamente.

Por ejemplo, si escribe un guión como parte de su documentación y no lo toca durante un año, su memoria de lo que hace o está haciendo el guión se desvanecerá y pasará más tiempo reelaborando o recordando cómo funciona. Esta situación es una evidente pérdida de tiempo. Mantener el script en una forma de control de código fuente con muchos comentarios es una alternativa más agradable y eficiente.

Cómo mejorar tu documentación

Mejorar sus habilidades de documentación es una mejor estrategia de IE que quedarse atrapado en una mentalidad cansada que dice que la documentación no es importante. En este tipo de situaciones, terminarás produciendo material mediocre y de bajo valor que no le sirve a nadie. Incluso si se desempeña a un alto nivel en otras áreas, su documentación deficiente podría eclipsar ese hecho.

Escribir es esencial para ser un administrador de sistemas. Sin duda, es de su interés trabajar para mejorarse a sí mismo en esta área. Lo creas o no, leer te convierte en un mejor escritor. Cuanto más lea con el tiempo, mejor será su escritura, así que lea libros técnicos y otros materiales relacionados. Además, cuanto más escribes, mejor te vuelves. Encuentre tiempo para escribir regularmente, como escribir un blog, publicar artículos o escribir libros blancos. Otra opción es la formación profesional, por supuesto. Linkedin aprendizaje, vista plural, y Udemy ofrecemos videos y lecciones de escritura.

Invierte tiempo en escribir, tal como lo haces para aumentar tus conocimientos técnicos. Mejorará la permanencia de su trabajo porque otros evitan la documentación como la peste, lo que significa que se convertirá en el administrador del sistema cuya documentación ayuda a apagar incendios rápidamente, mejora la colaboración y enseña a otros. También se asegurará de que es indispensable y puede estar orgulloso de todas las áreas de su trabajo como administrador del sistema. Escribir es como hacer flexiones: ¡cuanto más haces, más fuerte te vuelves!

Conclusión

Entonces, si cree que tiene una opción cuando se trata de documentación, está equivocado. No hagas tu tarea a la mitad. Asegúrese de dedicar el tiempo y la atención que merece la documentación. Estarás mejor, y también lo estarán los demás a tu alrededor.

Siempre tienes una opción: documentar o volverte inútil.

Artículos de interés

Subir