Estandares De Calidad

1

4

La documentación de un programa suele producirse con dos propósitos, el primeroseria explicar las funciones del software y describir el modo de utilizarlas estas estándiseñadas para ser leídas por el usuario del programa y la segunda describir elsoftware en si para poder mantener el sistema en una etapa posterior de su ciclo devida.La documentación de usuario es un instrumento muy importante. Una buenadocumentación de usuario hará al programa más accesible.El manual de usuario debe contener los siguientes puntos.



Ordenes necesarias para cargar el programa en memoria desde elalmacenamiento secundario y comenzar su funcionamiento.



Nombres de los archivos externos a los que accede el programa.



Formato de todos los mensajes de error o informes.



Opciones en el funcionamiento del programa.



Descripción detallada de la función realizada por el programa.



Descripción detallada de cualquier salida producida por el programa.Manual de mantenimientoEl manual de mantenimiento es la documentación requerida para mantener unprograma durante su ciclo de vida. Se divide en dos categorías, documentación internay documentación externa.Documentación internaEsta documentación cubre los aspectos del programa relativos a la sintaxis delenguaje. Esta documentación está contenida en los comentarios entre llaves,paréntesis o asteriscos. Algunos temas a considerar son:



Cabecera de programa (breve descripción del programa)



Nombres significativos para describir identificadores.



Comentarios relativos a la función del programa.



Claridad de estilo y formato, líneas en blanco para separa módulos.

1

5



Comentarios significativos.Documentación externaDocumentación ajena al programa fuente, que se suele incluir en un manual queacompaña al programa. Esta documentación debe incluir:



Listado actual del programa fuente.



Especificación del programa.



Diagrama de estructura que representa la organización jerárquica de losmódulos que comprenden el programa.



Explicaciones de formulas complejas.



Especificación de los datos a procesar.



Formatos de pantallas utilizados para interactuar con los usuarios.



Cualquier indicación especial que pueda servir a los programadores que debenmantener el programa.Reglas de documentaciónUn programa bien documentado es aquel que otras personas pueden leer, usar ymodificar. Existe muchos tipos de documentación y con frecuencia los temas a incluir dependen del programa. A continuación señalamos algunas características esencialesde documentación de un programa.Un comentario

...