Uno de los componentes más importantes de cualquier nueva implementación del sistema es la documentación. La documentación debe ser proporcionada tanto para el personal técnico y usuarios. Existen varias similitudes en los dos conjuntos de documentación, pero los dos también tienen algunas diferencias debidas a la audiencia objetivo.
Propósito
La documentación es esencial para la comprensión de un nuevo sistema. La documentación del sistema se describe cómo los operadores y otro personal del sistema deben interactuar con los archivos y plataformas que ejecutan un sistema informático. La documentación del usuario describe la forma en que el usuario debe interactuar con el sistema. Ejemplos de puntos de documentación de usuario incluyen cómo introducir datos, cómo buscar información y cómo interpretar los informes.
Nivel técnico
El nivel técnico de la documentación del sistema es mayor que la de la documentación del usuario, ya que el usuario no necesita conocer detalles específicos del sistema. Como un ejemplo, la documentación del sistema debe contener diagramas de flujo que describen el funcionamiento de los programas y archivos, mientras que la documentación de usuario debe contener imágenes de pantallas y ejemplos de informes. El personal del sistema necesitan saber más sobre el funcionamiento interno del sistema para proporcionar el nivel adecuado de apoyo tanto en las operaciones diarias y la resolución de problemas.
Legibilidad
Legibilidad depende de las necesidades del lector. personal de sistemas deben ser capaces de leer la documentación del usuario y entender rápidamente, mientras que los usuarios deben recibir los datos rápidos sobre cómo navegar por la interfaz. En ambos casos, es importante que la documentación sea legible por el público objetivo.
Mantenimiento
mantenimiento de la documentación debe ocurrir cada vez que se cambia un sistema. El mantenimiento podría afectar ya sea documentación del sistema, la documentación de usuario o ambos, dependiendo de la naturaleza de los cambios. Documentación de mantenimiento en todos los niveles se puede pasar por alto. Se requiere diligencia para asegurar la documentación actual de los usuarios y personal de sistemas.