programacion

UNIVERSIDAD DE EL SALVADOR
FACULTAD DE INGENIERÍA Y ARQUITECTURA
ESCUELA DE INGENIERÍA DE SISTEMAS INFORMÁTICOS
PROGRAMACIÓN I
UNIDAD III
DOCUMENTACIÓN DE ALGORITMOS (PROGRAMAS)
Objetivo: Conocer en qué consiste la Técnica de Documentación y su importancia en el diseño de
algoritmos, para iniciar a aplicarla después en nuestras soluciones de problemas.
Contenido:
•
•
•
•Introducción
Documentación de Algoritmos
Importancia de Documentación
Clasificación de la Documentación

1
1
2
3

Introducción
Los algoritmos o programas que diseñamos la mayoría de veces los hacemos para otras personas; es decir,
son utilizados por otras personas y no por quien los escribió. Por ejemplo, quien diseñó el programa para
calcular el salario a los empleados de una empresa,generalmente no es el que imprime las planillas; el que
diseña el programa para facturarle a un cliente de un almacén no es el que generalmente factura, etc.
Por esta razón, los algoritmos (o programas) deben ser fáciles de utilizar, debido a que la mayoría de las
veces quien utiliza el programa no tiene nociones de programación además, de que, quien les da
mantenimiento puede ser otro programador. Enlos siguientes ejemplos se evidencia esta necesidad de
escribir programas fáciles de utilizar:
El usuario tiene que saber, que tipo de datos introducir, en qué momento hacerlo y cuantos datos
introducir.
En el caso de las salidas de datos, el usuario o quien lee estos reportes, debe saber que representa esa
información.
Además para darle el mantenimiento necesario al algoritmo, se necesitasaber que hace, y como lo hace.
En este sentido, debemos recordar que nuestros algoritmos deben ser lo más claros y explícitos posibles,
para que otra persona, trabaje, modifique o califique nuestro trabajo.

La Documentación de algoritmos, es la parte de la Programación Estructurada que se encarga de escribir la
‘literatura’ necesaria para comprender perfectamente un algoritmo. Es una guía ocomunicación escrita en
variadas formas: enunciados, procedimientos, dibujos o diagramas, que ayudan a comprender y trabajar con
un programa.
Consiste en escribir detalladamente todo lo que se necesita conocer para trabajar con él y modificarlo por
mantenimiento, cuando sea requerido. Por ejemplo:

1

♦ ¿Qué hace el
algoritmo?

(Salida de datos)

♦ ¿Cómo lo hace?

(Procesamientode datos)

♦ ¿Qué necesita para
funcionar?
(hardware y software)

♦ ¿Qué tipo de
datos necesita?

♦ ¿Cuántos?

(Entrada de datos)

♦ ¿Cómo se divide en
partes o módulos?

♦ ¿Cuántos
módulos son?

♦ ¿Qué hace o
genera cada
uno?

(Salida de datos)

♦ ¿Quién lo hizo?

♦ ¿Cuándo lo
hizo?

♦ ¿Para
etc.

quién?, (Información general)

Debemos recordar conceptos yaconocidos:
ALGORITMO:
Serie de pasos que resuelven un problema.
PROGRAMA:

Algoritmo escrito en un lenguaje de programación,

PROGRAMADOR:

Persona que diseña un algoritmo (flujograma o pseudo código) y lo traduce o escribe en
un lenguaje de programación, en nuestro caso utilizamos C.

USUARIO:

Persona que utiliza un programa, no necesariamente escrito por él.

♦ Como ya se dijo, losprogramas o algoritmos son diseñados, muchas veces, para que otras personas,
usuarios, lo utilicen, por ejemplo los algoritmos que ustedes como estudiantes diseñan, los utilizamos los
profesores al revisarlos y calificarlos. La mayoría de veces los usuarios no tienen los conocimientos
necesarios (matemáticos o de programación) lo que dificulta la utilización del algoritmo, es aquí donde
radicala importancia y aplicación de la Documentación
El programador debe indicar al usuario como trabajar con el algoritmo, con las indicaciones siguientes:
Cuando introducir datos, qué tipo de datos, cuántos datos necesita introducir;
Si el proceso que realiza el programa toma un tiempo considerable (más de un minuto) debe
indicarle al usuario, por medio de una impresión que el programa está...