Administradores de sistemas: ¿qué opinan de la documentación del procedimiento?

Hoy en día, dondequiera que miro, veo procedimientos y documentación sobre cómo realizar una tarea. Es todo, desde una receta en línea para un delicioso coq au vin hasta instrucciones sobre cómo lavarse las manos en el inodoro. Nuestros negocios no son diferentes. Si hay una tarea que debe completar, es muy probable que tenga que explicársela a otra persona algún día. Las empresas quieren que sus empleados documenten estos procesos. No puedo decirle cuántas veces mi división escribió procedimientos para varias tareas mientras yo era submarinista. Después de eso, cuando estaba trabajando en soporte, si solucionaba un solo problema, se esperaba que documentara la solución después. Aquí hay algunos consejos para alguna documentación útil que recogí en el camino.

Índice

Tomar notas

La primera vez que se siente a escribir el procedimiento, le recomiendo que realice las acciones y tome muchas notas sobre la marcha. Incluye muchos detalles. Esto hace que su instrucción sea completa y facilita que el usuario la siga. Realmente quieres explicar demasiado aquí; Luego, cuando escriba el procedimiento real, tendrá toda la información disponible y podrá eliminar elementos innecesarios. El objetivo es ser completo, pero conciso.

Colocar notas

Siempre que necesite proporcionar información adicional sobre el resultado o la consecuencia de una acción, es mejor que proporcione la nota antes de la acción para que el usuario pueda tomar la decisión correcta sobre cómo proceder. No hay nada peor que realizar un paso en un procedimiento y luego ver una nota que explica cómo realmente debería haber usado ese indicador u opción para obtener el resultado deseado.

Escribir a la nueva persona

No, no asuma que sus compañeros de trabajo no son inteligentes. Sé que no todos nacen con los mismos dones intelectuales, pero ese no es el punto aquí. El punto es que siempre debe escribir un procedimiento o instrucciones para la persona más joven que podría estar usándolo. No tiene sentido escribir el procedimiento de tal manera que solo su ingeniero de sistemas más experimentado pueda leerlo, pero todos deberían pedir ayuda. Se remonta al punto de origen; quieres asegurarte de anotar cada acción, incluso la más básica.

control ficticio

Así como un editor usa un editor de copias, una persona que escribe un procedimiento debe hacer que otra persona realice el procedimiento de forma independiente. De esta manera, el usuario independiente puede notar los lugares donde las cosas no funcionan como se describe o los lugares donde necesita más claridad. Con el experto allí para guiarlos, puede corregir cualquier laguna en sus explicaciones.

obtener la aprobación

Este punto solo lo llevará hasta donde lo requiera su organización. En algunos equipos, cualquiera puede escribir un procedimiento y compartirlo. En otros, puede requerir firmas de aprobación de su jefe, el jefe del jefe, etc. Para todos mis subcontratistas militares o gubernamentales, no es raro que los procedimientos sean firmados por su gerente y, potencialmente, por el oficial al mando. Si bien este paso puede parecer complicado o simplemente "más papeleo" a veces, definitivamente es una buena idea. Si algo está mal y no ha obtenido la aprobación, es posible que deba actualizar su CV. Se inteligente; obtener sus procedimientos aprobados.

Llevar

Espero que encuentre estos consejos útiles en su propia vida. Estos se pueden aplicar a su documentación profesional y también a su escritura o blog personal. Si alguna vez ha querido escribir un artículo para este sitio, por ejemplo, estos consejos son una excelente descripción general de cómo comenzar un artículo de "instrucciones".

Artículos de interés

Subir