La documentación es un conjunto de información que expresa detalles de estos sistemas, la forma adecuada de operar con él, nos permite interpretar los errores, conocer su proceso, etc.
Es por ello que la documentación es un elemento clave en todo sistema o entorno de trabajo pues su principal objetivo es el de facilitar el desarrollo, corrección y futuro mantenimiento de la aplicación o entorno de una forma rápida y fácil.
También es necesario indicar que muchas veces no se le da el protagonismo que se merece, puesto que en la mayoría de los casos esta documentación es muy escasa o nula.
Como desarrolladores en las diferentes áreas de TI (tecnologías de la información) debemos de esforzarnos por adquirir, comprender y renovar la adecuada documentación de nuestros sistemas y entornos de trabajo
Podemos definir dos categorías para la documentación:
· Interna: Es aquella que se crea en el mismo código de la aplicación, ya puede ser en forma de comentarios o de archivos de información dentro de la aplicación.
· Externa: Es aquella que se escribe en cuadernos o libros, totalmente ajena a la aplicación en si. Dentro de esta categoría también se encuentra la ayuda electrónica.
La guía técnica
En la guía técnica o manual técnico se refleja el diseño del proyecto, la codificación de la aplicación y las pruebas realizadas para su correcto funcionamiento. Generalmente este documento esta diseñado para personas con conocimientos de informática
La guía de uso
Es lo que comúnmente llamamos el manual del usuario. Contiene la información necesaria para que los usuarios utilicen correctamente la aplicación.
La guía de instalación
La guía de instalación contiene la información necesaria para implementar dicha aplicación.
Dentro de este documento se encuentran las instrucciones para la puesta en marcha del sistema y las normas de utilización del mismo.
0 comentarios:
Publicar un comentario