Documentación de programas

Como ya se había mencionado, el programador es responsable de documentar adecuadamente los programas explicando cómo y por qué ciertos procedimientos se codifican en determinada forma. Una vez probado y aceptado el nuevo sistema, el programa debe quedar correctamente documentado, para posteriormente poder realizar el mantenimiento del mismo.

Toda la información que presentemos en los informes puede presentarse de diversas maneras, por ejemplo: diagramas de flujo, diccionario de datos, o cualquier otra técnica disponible.

Existen dos tipos de documentación: interna y externa.

La documentación interna se puede realizar utilizando terminología técnica para describir la estructura del sistema: datos y funciones. En ella se presenta información dirigida hacia el área técnica o de desarrollo de sistemas, incluyendo el posible origen de los datos, la descripción de algoritmos, estructuras de datos, flujo de control, etc.

Mientras que la documentación interna es concisa y está escrita en un nivel apropiado para un técnico o programador, la documentación externa se realiza para ser leída principalmente por quienes no conocen un lenguaje técnico.

La documentación externa se encarga de elaborar un informe del diseño del sistema en forma más amplia y detallada, ya que esta deberá estar dirigida a los usuarios y a los clientes en un lenguaje natural para describirles que es lo que el sistema hace.

Fuente: Informática I de la facultad de contaduría y administración, UNAM.

Publicado en Informática

Suscríbete:

who's online