Actividad # 9

Actividad # 9

En esta entrada explicare acerca de la documentación técnica y la importancia de este en la programación.

Varios programadores entienden que el documentar software consisten en solo hacer el Diagrama de Clases o de Secuencia del código. La documentación no consiste en eso, y muchas veces los programadores no documentan los proyectos y no acompañan a los desarrolladores en el proceso de documentación.

http://www.gratisblog.com/weblogs/darkdreams26/diagrama_de_clases.JPG

De los beneficios de esto es facilitar la utilización del código por parte del usuario y recordar que se realizo en el código para llegar  a lo que esta codificado, ya que documentando lo realizo alguien puede tomar el código y puede acortarlo o hacerlo mas funcional esto garantiza la permanencia y disminuye los costos de operación y de ejecución del proyecto como tal.

http://cubodedatos.com/images/site/especialistasistemasinformacion-918.jpg

Para realizar la documentación hay varios programas dependiendo el código que manejes o simplemente documentan cualquier código utilizado o con el solo hecho de poner comentarios en la estructura del código.

Por ejemplo en mi caso yo pienso utilizar JAVADoc para realizar lo anterior ya que aparte que me documentaría el código de mi proyecto podre ponerle comentarios para cuando vuelva a ver mi proyecto recuerde como realice eso.

Otra forma de documentar aunque lo recomendable es con un software que realice esto, seria realizar un documento que tenga información del proyecto:

• Dar una breve descripción de lo que realice tu código.
• Lenguaje utilizado y porque.
• Clases del software y explicar cual es la función principal de esa clase.
• Métodos y lo que haría cada uno.

Referencias

http://mx.globedia.com/documentacion-de-software

http://www.dosideas.com/noticias/metodologias/298-como-documentar-la-arquitectura-de-software.html