Documentacion & Depuracion

DEPURACION

(Depuración de errores, debugging). El debugging o depuración es el proceso metodológico para encontrar y reducir bugs (errores) o defectos en un programa informático o en una pieza de hardware.

La tarea de depuración de un error de software, suele requerir los siguientes pasos.

* Reconocer que ese error existe (un programa puede contener errores que jamás serán detectados).

* Aislar la fuente del error.

* Identificar la causa del error.

* Determinar una solución para el error.

* Aplicar la solución.

* Probar el programa.

En general, las tareas de la depuración de errores, suelen ser engorrosas y agotadoras. Existen aplicaciones que permiten ayudar al programador en estas tareas, pero es la habilidad del mismo el factor más determinante para la efectividad y eficiencia del proceso de depuración.

Los programas para la depuración son llamados depuradores o debugger (también es el nombre que recibe el programador que realiza esta tarea). Permiten ejecutar un programa, hacer pausas, volver a comenzarlo, ejecutarlo por partes, ver o cambiar los valores de las variables, etc. (Ver Punto de parada o breakpoint).

En tanto, para la depuración de errores en hardware se suele utilizar: software de bajo nivel, firmware, instrumentos específicos (osciloscopios, analizadores lógicos o emuladores de circuitos), etc.

DOCUMENTACION

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 sí. 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 está 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 está 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

...