Importancia de la documentación

  • Por
Describimos los aspectos claves para el desarrollo de una buena documentación del programa a entregar al cliente.
La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones, sin necesidad de conocerse el código al dedillo.

La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación.

Una vez concluido el programa, los documentos que se deben entregar son una guía técnica, una guía de uso y de instalación.

Tipos de documentación

La documentación que se entrega al cliente se divide claramente en dos categorías, interna y externa:

  • Interna: Es aquella que se crea en el mismo código, 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 reflejan 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, generalmente programadores.

El principal objetivo es el de facilitar el desarrollo, corrección y futuro mantenimiento de la aplicación de una forma rápida y fácil.

Esta guía esta compuesta por tres apartados claramente diferenciados:

  • Cuaderno de carga: Es donde queda reflejada la solución o diseño de la aplicación.
    Esta parte de la guía es únicamente destinada a los programadores. Debe estar realizado de tal forma que permita la división del trabajo
  • Programa fuente: Es donde se incluye la codificación realizada por los programadores. Este documento puede tener, a su vez, otra documentación para su mejor comprensión y puede ser de gran ayuda para el mantenimiento o desarrollo mejorado de la aplicación. Este documento debe tener una gran claridad en su escritura para su fácil comprensión.
  • Pruebas: es el documento donde se especifican el tipo de pruebas realizadas a lo largo de todo el proyecto y los resultados obtenidos.
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.

Este documento se hace desde la guía técnica pero se suprimen los tecnicismos y se presenta de forma que sea entendible para el usuario que no sea experto en informática.

Un punto a tener en cuenta en su creación es que no debe hacer referencia a ningún apartado de la guía técnica y en el caso de que se haga uso de algún tecnicismo debe ir acompañado de un glosario al final de la misma para su fácil comprensión.

La guía de instalación

Es la guía que 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.

Dentro de las normas de utilización se incluyen también las normas de seguridad, tanto las físicas como las referentes al acceso a la información.

Autor

Sara Alvarez

Equipo DesarrolloWeb.com

Compartir

Comentarios

willy

17/7/2006
Tienen algún ejemplo online para tener como guia?

Gabriel Bulla

18/7/2006
Me parece muy interesante el tema porque aunque parezca algo muy logico el tipo de documentacion de un sistema, normalmente nunca se desarrolla. Me parece que se debe complementar el tema con algunas metodologias y estandares adecuadas para realizar esta labor. Gracias.

nano

27/1/2008
la verdad es que este articulo no es demasiado correcto, habria que empezar con un analisis del problema, estado del arte(estudio de aplicaciones relacionadas con lo que queremos realizar), analisis de viabilidad...
Una vez decidida una solución al problema y su viabilidad, desarrollar diagramas de gantt(para estructurar en el tiempo el proyecto),casos de uso(funciones que desarrolla el sistema para los diferentes actores que interactuan con la aplicación),diagramas de flujos de trabajo, secuenciales...
Se deberían documentar todas las funcionalidades describiendo entras y salidas de datos, precondiciones y postcondiciones de la funcionalidad , con pruebas con datos correctos y erroneos.
en fin, que para ser un tutorial de documentación le falta mucho contenido.

edison

23/10/2009
explicar
explicar por que este articulo vale verga!!!!!!!!!!!
toda una webada

daryin

18/4/2014
este tema es muy importante porque se habla de la importancia de la documentación
La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones, sin necesidad de conocerse el código al dedillo.