Criterio de documentación

Así como el funcionamiento de un centro de datos es incierto sin estándares, la preparación de la documentación sufrirá de varios males si los estándares no son establecidos para guiar las actividades. Los males que pueden resultar caen en dos categorías generales y son también el criterio para la evaluación de la documentación: fallos en el contenido y fallos en el formato.

Las fallas típicas en el contenido son ausencia de información necesaria, explicaciones totalmente imprecisas e información difícil de localizar. Los males resultantes de fallos en el formato causan problemas de archivamiento, dificultad en la localización de información frecuentemente referenciada y frustración y errores en la actualización de la documentación. A continuación se explicarán los cuatro criterios del contenido y los tres criterios del formato para la documentación:

  1. Precisión. Los medios obvios para la obtención de información precisa es el obtenerlos de aquellos que están más involucrados últimamente con los detalles que están siendo documentados. Por ejemplo es común el tener a personas que desarrollen o evalúen sistemas de librería, documentar procedimientos y diseñar formas para sistemas de librerías sin hablar con el personal en la librería, excepto posiblemente por unos cuantos pedazos de información dispersada.
  2. Integridad. Si una tarea se supone será aceptada para la producción sólamente si es acompañada por documentación específica, tal como la preparación total de datos, procesamiento de computadora e información posterior al procesamiento, no debería ser aceptado al menos que esté completo. Muy frecuentemente una tarea es aceptada con el entendimiento de que la documentación será proporcionada pronto.
  3. Claridad. La claridad depende de la estructura de las sentencias, la relación entre las sentencias y la lección de las palabras. La estructura de las sentencias debería ser directa. Cada declaración debería hacer claro lo que está siendo documentado y qué se está diciendo acerca de ese tema.
  4. Conciso. La meta de la documentación es el guiar actividades, y si la documentación es voluminosa e inmanejable, su uso se hace tedioso y puede ser evitado. Cuando son utilizadas formas y tablas, la información puede ser comprimida, permitiendo un rápido y fácil acceso.
  5. Facilidad de referencia. Se refiere a la facilidad para localizar información tal como números de control en los documentos. Es obvio, por ejemplo que si la documentación será archivada por número de tarea, ese número debería estar en una locación evidente.
  6. Facilidad de uso. Si una forma es utilizada por más de una persona, en lugar de forzar a una persona a introducir información en varias locaciones de la forma, toda la información relevante a cada persona debería ser agrupada conjuntamente. Si la información será introducida sólo una vez, pero referenciada varias veces, entonces obviamente la secuencia que es mejor para referenciar esta información debe ser elegida.
  7. Facilidad de mantenimiento. El secreto de un mantenimiento sencillo es la modularidad. Lo cual consiste en la separación de la documentación en pequeños módulos, lo cual permite el reemplazo de sólo aquellos tópicos alterados y no afecta cualquier otro tópico.

Fuente: Apunte Administración de servicios de cómputo del Instituto tecnológico de la Paz

Publicado en Administración de los servicios de cómputo

Suscríbete:

who's online