a prende a programar

aprenderaprogramar.com

 
 
Documentación de programas 
informáticos: documentación para 
el usuario y para mantenimiento. 
(CU00250A) Sección: Cursos                                               
Categoría: Curso Bases de la programación Nivel II 
Fecha última actualización: 2012 
Autor: Mario R. Rancel 
Resumen: Entrega nº 49 del Curso Bases de la programación Nivel II 

12

© 2006-2012 aprenderaprogramar.comDocumentación de programas: documentación para el usuario y para mantenimiento.

DOCUMENTACIÓN PARA EL USUARIO 
La documentación para el usuario constituye un elemento de consulta para toda aquellapersona que
va a usar el programa por primera vez o que trata de saber si el programa servirá a sus objetivos.
Igualmente es útil para usuarios que ya realizan un manejo básico y quieren profundizarhacia un
conocimiento avanzado. Una documentación completa contendría:










Portada con el nombre del programa, versión y autor o autores.
Índice.
Descripción muy breve de lasfunciones y posibilidades del programa.
Descripción breve del método de cálculo principal.
Explicación breve de cómo debe usarse el programa y de los datos de entrada, opciones y
resultados.Ejemplos paso a paso de uso del programa en número suficiente para comprender las posibilidades
que se brindan.
Diagrama de flujo del programa de carácter sintético y descriptivo.
Especificacióndetallada de todas las opciones contenidas en menús.
Especificación detallada de todos los cálculos, principales y secundarios.

La extensión de la documentación para el usuario será variable en funciónde la complejidad y
características del programa: puede ir desde un párrafo para programas muy sencillos y de fácil uso
hasta centenares de páginas para programas comerciales complejos. Los puntoscontenidos en la
documentación también son variables, siendo los enumerados anteriormente una orientación. Para
programas sencillos puede reducirse a un...