La documentación proporciona pistas de auditoría al trabajo que se ha completado

# 13: Documento Todo

La importancia de una buena documentación, sólido, simplemente no puede ser exagerada. Documentación proporciona pistas de auditoría al trabajo que se ha completado. Proporciona guías para los administradores de sistemas futuros de manera que puedan hacerse cargo de los sistemas que existían antes de que llegaran. Se puede proporcionar al administrador del sistema y su gestión con los registros de la realización. (Estos pueden ser muy útiles en el personal de tiempo de revisión.) Buena documentación también puede ayudar en la solución de problemas.

1. El primer público es el propio autor. Documentación destinada a que el autor del software hace que sea mucho más fácil para el autor que volver y depurar problemas en su propio código que puede ocurrir años más tarde. Cuando miramos hacia atrás en tu propio motor de dos o tres años de trabajo de edad (de sistema o diseño de redes o programas, por ejemplo), puede ser casi imposible de recordar por qué lo hiciste algo de una manera particular y no de otra manera, a pesar de haber excelentes razones a la vez. Escribir comentarios en el código. Escribir manuales, incluso si son sólo un par de páginas.

2. El segundo público consiste en algún momento en el futuro. La gente que mantiene los sistemas y las aplicaciones de hoy no van a estar ahí para siempre. Y no se puede asumir que todo el personal experimentado estará en torno a los nuevos mentores. Usted debe prepararse para un éxodo masivo de su gente con experiencia. Un signo popular en las mesas muchos administradores de sistemas se lee: "Recuerde, 100 años a partir de ahora, toda la gente nueva!"

3. La audiencia tercero es la gestión. Mantenimiento de las buenas notas y documentar su trabajo contribuye a demostrar a la dirección que usted ha sido diligente y muestra lo que se han tomado medidas para mantener los sistemas que ejecutan y productivo. Si un sistema no cumple los requisitos establecidos en la documentación, debe ser fácil de averiguar por qué y para determinar qué debe hacerse para que el sistema sea compatible. Incluso si su gestión no entiende el valor de los servicios que ofrece a la organización, por lo general se entiende el valor cuando se presenta como un grueso paquete de documentación.

Asegúrese de que la documentación se almacena en papel también. Si el sistema está inactivo cuando es necesario los manuales, no vamos a ser capaces de llegar a ellos. Manténgalos en carpetas para que puedan ser fácilmente modificado y actualizado. Después de que la documentación está escrita, no se olvide de revisarlo y actualizarlo periódicamente. Documentación Bad es peor que nada. En una crisis, especialmente si las personas mejor informadas no están cerca, la documentación es probable que sea seguido literalmente. Si es malo, las cosas pueden ir de mal en peor. Una pregunta común acerca de la preparación de la documentación es a qué nivel técnico debe ser escrito. Una escuela de pensamiento dice que la documentación debe ser por escrito para que cualquiera en la organización, de un portero con el CEO, puede seguir y, si es necesario, acercar los sistemas después de un desastre. Después de todo, el sistema de personal administrativo no puede estar disponible en el tiempo, y alguien tiene que hacerlo. Mientras que es un objetivo noble, de que es muy poco práctico. El estado de los cambios de sistemas críticos todo el tiempo. El más detalle que se incluye en dicha documentación, más rápido se hace fuera de fecha. Para escribir la documentación para que una persona inteligente sin formación podría aportar a los sistemas o realizar trabajos de crítica relativa a las mismas en tiempo de crisis, tendría que ser tan detallada como para ser inmanejable. Si la tarea es editar un archivo cambio de una variable a otra, de un administrador del sistema con la formación adecuada, la única documentación que necesita decir, "Cambio de ABC a XYZ en el directorio / / archivo.txt." Para que una persona inteligente sin formación, la documentación que tendría que decir:

1. Cambia al directorio / directorio escribiendo "cd / directorio".

2. Abra el editor de texto vi escribiendo "vi archivo.txt".

3. Mueve el cursor hasta la línea 300, escribiendo "300G".

y así sucesivamente (en cualquier entorno operativo es apropiado). Cada vez que el número de línea en el archivo cambiado, la documentación tendrá que ser cambiado. Condiciones de error Muchos necesitan ser manipulados por la persona sin experiencia, así como, por ejemplo, si el tipo de terminal o el recuento de la línea se encuentra mal, el editor vi puede tener problemas para tratar con ella. En ese caso, ¿qué debe hacer la persona sin experiencia? La respuesta correcta, por lo tanto, es escribir la documentación para que un administrador de sistema experimentado podría utilizarlo. No espere que el administrador tenga una gran experiencia en su tienda, sólo la experiencia general. En un entorno Windows, dirigidas a un Microsoft Certified Engineer (MSCE). En entornos Unix, los administradores experimentados del sistema de destino. Si algo ocurre en el sistema actual personal administrativo, se puede suponer razonablemente que serán sustituidos por personas con experiencia. La documentación es muy parecido a una fina pieza de literatura. Todo el mundo quiere decir que ha leído Moby Dick, pero en realidad nadie quiere sentarse a leer Moby Dick.

# 12: Emplear los Acuerdos de Nivel de Servicio

# 11: Planifique con anticipación

un artículo presentado por Ben Smeider

Descargo de responsabilidad:Nuestro sitio web no es responsable por el contenido de este artículo. Webarticles es un recurso de información gratuito.
Importante: Este artículo "La documentación proporciona las pistas de auditoría al trabajo que se ha completado", fue traducida por un software automático. Sentimos pena por los errores de ortografía que pueda haber ocurrido. Gracias por su comprensión.