Documentacion tecnica de un programa



El manual técnico es documentación externa que describe con profundidad las características técnicas y funcionamiento del programa (o sistema). Está destinado a los programadores y sirve de referencia para darle mantenimiento al sistema durante su vida útil.

Los elementos generales de un manual técnico son:


a) Propósitos y funcionamiento del programa. b) Esquema lógico del funcionamiento del programa c) Nuevos tipos definidos, principales variables globales, archivos utilizados, etc. d) Explicación de fórmulas y procesos complejos. e) Especificación de datos de entrada y datos de salida. f) Formato de los archivos y de las pantallas. g) Datos utilizados en las pruebas. h) Puntos débiles y futuras expansiones. i) Guía de Referencia de Rutinas. j) Diagramas. k) Listado del programa fuente. l) Otras características técnicas

Este manual suele quedarse en el lugar de desarrollo, tanto para futuros cambios, como para verificar que fue correctamente instalado; por ejemplo si una vez que el programa ha sido puesto en funcionamiento ocurre un error, los datos de prueba servirán como parámetro para tratar de detectar cuál fue el percance.

Otra información útil que puede tener este manual es el tamaño (en bytes) de los archivos ejecutables, pues un cambio inesperado podría sugerir la presencia de un virus. Otro de los puntos interesantes son los puntos débiles, mencionarlos puede servir para saber por dónde podría fallar el programa en algún momento, o por donde se le puede mejorar.

Si usted ha trabajado con componentes electrónicos, seguramente conocerá la importancia del manual que detalla todas las características y funcionamiento de los mismos. Otro ejemplo de documentación técnica son los manuales que describen elementos importantes de una computadora, como su mapa de memoria, asignación de puertos o interrupciones, y los libros que indican los parámetros de esas interrupciones y su propósito. Gracias a María del Carmen Ozuna por colaborarnos este artículo para ser publicado en ARQHYS.com…

Para citar este articulo en formato APA: ( ARQHYS. 2011, 08. Documentacion tecnica de un programa. Revista ARQHYS.com. Obtenido , de http://www.arqhys.com/general/documentacion-tecnica-de-un-programa.html.)




Deja un comentario