Manual Tcnico

Qu es un manual tcnico?
Un manual tcnico es aquel que va dirigido a un pblico con conocimientos tcnicos sobre
algn rea.
La documentacin de proyectos es importante para identificar ms fcilmente los aspectos y
caractersticas que forman parte de un proyecto. Una adecuada documentacin le
proporciona identidad y "personalidad" a un proyecto, de manera que los usuarios
irresponsables del mismo podrn reconocer ms fcilmente las ventajas y desventajas,
caractersticas y funcionalidades, funciones y ventajas, as como costos y beneficios que
impliquen el desarrollo del proyecto
Componentes de un manual Tcnico
1. Portada
2. Contraportada
2.1.

Identificacin del documento

2.2.

Logotipo de la organizacin

2.3.

Nombre oficial de la organizacin

2.4.

Lugar y fecha de elaboracin

2.5.

Numero de revisin

2.6.

Responsables de la elaboracin

3. Introduccin
4. Objetivos
5. Contenidos Tcnicos
5.1.

Reglas de negocio

5.2.

Requerimientos funcionales y no funcionales.

5.3.

Diagramas de flujo,

5.4.

Casos de Uso.

5.5.

Diccionario de datos.

5.6.

Diagrama de navegacin del sistema.

6. Documentacin del Cdigo.

7. Glosario.

Generar JavaDoc usando Eclipse IDE

Siguiendo con la documentacin de nuestro proyecto, veremos cmo vamos a generar dicha
documentacin usando un asistente que provee Eclipse, para esto solo es cuestin de seguir
algunos pasos.
Veamos a continuacin que pasos son:
Una vez tengamos nuestro proyecto documentado como se mostr en la entrada anterior,
podemos continuar con la generacin de dicha documentacin.

Luego nos dirigimos al men Project y seleccionamos la opcin Gerarar JavaDoc.

Luego nos aparecer un asistente que nos ayudara con esta tarea. Nos aseguramos de tener
seleccionado el proyecto al cual le generaremos la documentacin y debemos indicarle donde
esta el javadoc.exe, la herramienta que nos ayuda a generar la documentacin, que siempre
esta en el jdk, en la carpeta bin.

Ingresamos el titulo principal de dicha documentacin y nos aseguramos de chequear el

proyecto y presionamos siguiente.

Luego veremos la siguiente pantalla con algunas configuraciones adicionales, podemos

dejarla en blanco si as lo deseamos.

Hecho esto, veremos una carpeta llamada doc, en nuestro proyecto, dentro de ella se
encuentran los archivos generados, son archivos html, junto con los estilos y dems que
vienen por defecto para la documentacin en java.

Si nos vamos a la raiz del proyecto veremos la carpeta as como en la siguiente imagen.

Y dentro de ella veremos los archivos que mencione anteriormente.

Al abrir el archivo index.html veremos la siguiente pantalla con toda la documentacin

generada, ademas podremos navegar fcilmente entre las clases, mtodos y dems.

Como vern es muy til generar la documentacin de nuestros proyecto, ya que nos guan y
dan una idea de que hace cada clase, mtodo y dems de nuestro proyecto. Deberamos
incluirlo en nuestro hbitos de desarrollo por que es mejor ir haciendo la documentacin a
medida que se avanza el proyecto que documentar todo despues.