DOCUMENTACIÓN DE UN PROGRAMA

¿Qué es la documentación de un programa?

Para que el mantenimiento de una aplicación informática sea lo más fácil posible, es conveniente disponer de toda su documentación, esto es, de todos los documentos que se han ido generando en todas las etapas anteriores: ERS (Especificaciones de Requerimientos de Software), algoritmos, códigos fuentes, manuales de usuario, etc. A todo este tipo de documentación se le considera externa. Además, existe otro tipo de documentación llamada interna.

La documentación interna de un programa son los comentarios que el programador puede escribir en el código fuente de un programa y que el compilador no tendrá en cuenta, ya que, no son instrucciones. Los comentarios de un programa son explicaciones o aclaraciones que ayudarán al programador en un futuro, cuando quiera revisar o modificar el código fuente de dicho programa, y todavía serán de más ayuda si la modificación la tiene que realizar un programador distinto al que escribió el código fuente en un primer momento.
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.