Esta bien yo tambien me incluyo aunque no siempre es asi, generalmente quizas muchos coincidan conmigo pero al hacer sofwtware que en realidad son scripts de un alto funcionamiento pero de pequeño codigo no consideramos que deba tener documentacion, es mas es porque es para un uso comercial personal .. pero..
Cuando comenzamos a hacer proyectos de mayor magnitud llamese sistema, portal inteligente, RIA, es necesario documentar... esteee disculpa xyox pero a que te refieres con documentar..
Cito:
En otras palabras, la documentación es un conjunto de información que expresa detalles de estos sistemas, la forma adecuada de operar con él, nos permite interpretar los errores, conocer su proceso, etc.
Bueno esto podemos decir que es algo tedioso, algo cansado, pero es algo que cuando lo terminemos nos dara un mejor nivel capaces de solucionar errores rapidamente y no cometerlos posteriormente, debe ser una costumbre nuestra.. a continuacion copypasteo el post realizado por ElCodigoK...
Si bien sabemos la importancia que tiene la documentación en los sistemas y aún sabiendo esto, rara vez hacemos el intento de documentar los procesos del sistemas, las funciones que incorpora, la estructura general de clases y ni hablar de los modelados de datos.
Creo que esta cuestión esta ligada por sobre todas las cosas a varios factores que voy a mencionar:
Falta de personas en un proyecto
Definitivamente es una variable que en la mayoría de los proyectos de software sucede y que es la falta de personas en los proyectos. Dependiendo del proyecto la cantidad de Ingenieros, Analistas o Programadores va a variar notablemente, y ésta falta de integrantes se hace sentir para tener todo documentado, seguramente los Analistas estarán preocupados en realizar un análisis y diseño perfecto, mientras que los desarrolladores se preocuparán más por la programación y las funcionalidades del sistema.
Mala distribución de las tareas
Vamos a suponer que nuestro limitante ahora no es la falta de personal, sino más bien una mala distribución de las tareas asignadas, dejando de lado y solo al final del proyecto la creación de los documentos y la propia documentación del código fuente. Esto también esta aparejado con el bajo control de exigencia para con estos documentos y por sobre todas las cosas no dejarlos como una última tarea sino más bien como una tarea paralela al Análisis, Diseño, Desarrollo y Pruebas.
Falta de experiencia
Nuevo limitante para la documentación, la experiencia es un factor importante y nos lleva a tener una buena idea de redacción y corrección de documentación precisa. Es de suma importancia adquirir experiencia en este tipo de tareas de documentación, tanto para no escribir documentos obsoletos y para que no falte información del proyecto.
No utilizar herramientas adecuadas
En la actualidad, la mayoría de los lenguajes de programación cuentan con herramientas que nos permite tanto organizar como agilizar el proceso de documentación en los códigos fuente. Con formatos mucho más profesionales y casi instantáneos, el echo de no utilizar estas herramientas hace que muchos de los programadores ni siquiera intenten documentar los procesos más importantes, las clases padres, etc.
Todos estos factores y seguramente muchos más hacen que la documentación de los proyectos de software sea nula, escasa, obsoleta, etc
Esto sin dudas es una tarea de suma importancia y un proceso de aprendizaje que no debemos dejar nunca de lado.
Saludos 
RSS Feed
Twitter
January 17th, 2010 
XYOX 
