Reporte 4: Documentación de un proyecto

Hola, que tal otra vez a todos. Ahora en ésta entrada hablaremos un poco acerca de la documentación de un proyecto de software, su importancia y algunas formas de como hacerla.

¿Porqué hay que documentar un proyecto? o ¿Cuál es su importancia?

La razón de ésta pregunta es que, al documentar un proyecto, un programa ó prácticas de programación nos sirven mucho al momento de poderlo reutilizar, ¿Porqué reutilizarlo?, si nos damos cuenta, en la programación se utiliza muchos códigos que ya habíamos empleado, como por ejemplo, cuando empezabamos a enseñarnos a programar pues vimos algoritmos y en algunas ocaciones programabamos éstas para entender su funcionamiento y tener una idea vaga de como nos serviría o como lo podríamos utilizar, así que le poníamos comentarios para que no se nos olvidara algún detalle o para que o como era una función. Una vez que vamos avanzando y desarrollando software nos vamos dando cuenta de que éstos nos son muy útiles, porque nos van ahorrando pasos y ayuda a hacer las cosas más simples, así que usabamos éste código o si ya habíamos desarrollado algún programa, solo sería necesario ver los comentarios y tomar la parte que nos interesa o es útil, sin tomarnos la molestia de leer todo el código.

Aparte que la documentación nos sirve para cuando le demos el software al cliente o compartamos nuestro código éste sepa como funciona, su instalación, su guía tecnica entre otras.
En pocas pallabras, la documentación es un conjunto de información que nos da detalles del software desarrollado ó que se ésta desarrollando, como sería la forma de trabajo de ésta, saber su proceso, su estructura y/o en alguna ocasión saber donde podría estar un error del programa.

¿Cómo podríamos documentar un código de un programa?

Hay muchas formas muy útiles y de gran ayuda, que nos permiten documentar el código de un programa. Como por ejemplo si queremos documentar un programa en lenguaje java, usamos la utilidad javadoc, la cual, ésta nos permite generar documentos de APIs en formato HTML y que ésta documenta las clases del programa y comentarios que se pongan en éste.
Para python hay varias utilidades, una de ellas es PythonDoc, que hace lo mismo que javadoc, te genera documentos de APIs en formato HTML u algún otro formato que se necesite, otra utilidad podría ser Epydoc que también hace lo mismo que PythonDoc, solo que éste te lo documenta en HTML o pdf.
Para lenguaje como php ésta la utilidad phpDocumentor que también hace exactamente lo mismo que las anteriores utilidades.
Y así podría seguir diciendo varias utilidades que nos pueden servir para documentar, ya que hay varias y para diferentes lenguajes, solo es cuenstión de dar una busqueda en google.

Por lo pronto será todo, si tienen alguna duda o sugerencia, comentenla y será eschuchada.
Saludos