Documentación Interna En Java

Forma de Presentación de la documentación del Proyecto o Tarea Programada

A continuación se presenta el formato y la forma de realizar la documentación de proyecto, tanto el manual de usuario como manual técnico.

a) Manual del Usuario:

El usuario potencial, no tiene porqué entender cómo se diseñó el programa, ni tiene tampoco porqué entender el código ni todo lo relativo; basta con que sea capaz de usar eficientemente el sistema, para poder explotarlo adecuadamente.

El manual de usuario debe ser claro, explícito y completo.

Debe incluir:

 Portada: La cual debe incluir como mínimo la información para contextualizar el trabajo en cuanto al lugar, tiempo, y autor del trabajo o autores. Por lo tanto debe incluir: El nombre de la Universidad, Facultad, Escuela o Departamento, Carrera que cursa, código y nombre del curso, identificación del grupo (si aplica), nombre del profesor, nombre y número de identificación del estudiante y finalmente la fecha en que se entrega el proyecto.

 Tabla de contenido: Utilizar número en cada página excepto en la portada y generar la tabla de contenido.

 Introducción: Debe incluir como mínimo la descripción del funcionamiento general del sistema.

 Explicación pormenorizada del uso del sistema: Explicar en forma clara y sencilla la utilización del sistema, se deberán presentar las diferentes pantallas del sistema en ejecución (en el caso de una solución en que se imprime en consola, serán las diferentes impresiones donde se le muestra algo al usuario y se le solicitan datos) que muestren los principales elementos descritos en la explicación. Tome en cuenta que este manual es para personas que no son del área de informática, por lo que debe tratar de ser lo más claro posible pensando en la diversidad de personas que pueden llegar a utilizar su sistema.

Nota: la pantalla presentada no corresponde al menú solicitado en este proyecto, solamente tiene carácter ilustrativo.). En el caso de que hayan pantallas muy similares o iguales pueden indicar la funcionalidad para la primera (ej en Pantalla #4) y que para otras pantallas la funcionalidad es la misma. Ej Pantalla #4 (para las pantallas #5, #6 y #7 la funcionalidad es igual a la descrita a continuación)

Observaciones sobre el manual de usuario:

El manual del usuario no deberá abarcar los siguientes puntos:

 Terminología técnica sobre programación.

 No debe hablar del lenguaje en el cual se implementó el sistema.

 No puede utilizar términos como variables, ciclos, etc.

 Soluciones a problemas que tengan que ver con configuración de drivers, máquina virtual, compatibilidad de hardware, software, etc.

 No debe ser escrito en lenguaje técnico, pues debe ir orientado al usuario final.

2

b) Documentación Técnica (Manual de Diseño)

El usuario encargado de mantenimiento y operación de los programas, debe entender cómo se diseñó el programa, el código y todo lo relativo.

Debe incluir:

 Portada: La cual debe incluir como mínimo la información para contextualizar el trabajo en cuanto al lugar, tiempo, y autor del trabajo o autores. Por lo tanto debe incluir: El nombre de la Universidad, Facultad, Escuela o Departamento, Carrera que cursa, código y nombre del curso, identificación del grupo (si aplica), nombre del profesor, nombre y número de identificación del estudiante y finalmente la fecha en que se entrega el proyecto.

 Tabla de contenido: Utilizar número en cada página excepto en la portada y generar la tabla de contenido.

 Introducción: Debe incluir como mínimo la descripción del problema a resolver. Aquí deben indicar el porcentaje de trabajo de los miembros del grupo y si tuvieron inconvenientes con algún miembro.

Solución del problema:

 Explicar de forma general y de manera técnica cada solución a cada subproblema principal de la aplicación. Se deben presentar las decisiones que fueron claves para el desarrollo del trabajo. Deben recordar que un buen programador se debe apegar rigurosamente a la especificación del problema que se le plantea. Por lo tanto, en este análisis debe incluir detalles que en la especificación presentan un cierto grado de ambigüedad o que no quedan muy claros y que decisiones tomaron para implementarlos o que aspectos asumieron para su realización.

 Explicar cada una de las clases (su función, una descripción de sus atributos y métodos importantes).

...