Documentación

Dentro del ciclo de vida del SW existe un apartado que es el de la documentación. Durante todo el proceso que dura el ciclo de vida de un programa o SW en cada etapa se deben de ir generando documentos en los que se vayan anotando todos los pasos que se van dando para la conclusión del mismo.

La documentación puede ser escrita de diferentes formas, enunciados, dibujos, diagramas, comentarios en el código fuente. Es de gran importancia que todos estos datos se realicen con la mayor claridad posible y su objetivo final es que puedan ser entendidos por cualquier otra persona diferente al creador de ésta.

La finalidad de este proceso es muy concreta y es con miras a futuras ampliaciones o a la posible corrección de errores, porque no nos engañemos, todos los programas tienen errores y descubrirlos sólo es cuestión de tiempo.

Los programas sufren modificaciones y el que sufran muchas o pocas sólo dependerá del existo del propio SW. Cuanto más éxito tenga la aplicación muchas más modificaciones sufrirá a lo largo de su vida, y como es lógico no siempre estará ahí el creador del SW para hacerlas o para reparar los posibles errores.

La documentación podría dividirse en tres apartados bastante bien diferenciados que serían:

1. La documentación interna:
Está formada por los comentarios o mensajes que se añaden en el código fuente.
Esta es la más importante a la hora de futuras modificaciones o para dar solución a errores. Se incluirían en este apartado las precondiciones y poscondiciones de cada función. Existen varias herramientas que generan este tipo de documentación. Para no entrar en mucho detalle en este sentido citaremos únicamente una de estas herramientas, la que creemos en nuestra modesta opinión que es la más popular y es
javadoc una utilidad de Oracle para la generación de documentación.

2. La documentación externa:
Para este tipo de documentación se define un documento escrito que incluye los siguientes apartados:
a. Parte técnica de los pasos seguidos desde el inicio del ciclo de vida(Análisis) hasta el final (Usuario).
b. Autor de dicho documento.
c. Algoritmos (diagramas de flujo o pseudocódigo).
d. Diccionario de datos
e. El código fuente programa

3. Documentación de usuario:
Es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan el producto SW final. Por lo general, este documento está escrito por un escritor técnico, Aunque a veces los documentos del usuario están escritos por los programadores del SW, los directores de proyectos, o el personal técnico, especialmente en las empresas más pequeñas.
Fuentes:
http://www.virtual.unal.edu.co/cursos/sedes/manizales/4060024/Lecciones/Capitulo%20I/problemas.htm

http://www.lab.dit.upm.es/~lprg/material/apuntes/doc/doc.htm

http://javabasico.osmosislatina.com/curso/progbasico2/documentacion.htm