El CoDiGo K >>> print "Tu puedes brillar, no importa de que estes hecho."

¿Qué tan importante es la documentación que acompaña a las aplicaciones o sistemas? La respuesta puede llegar a ser muy simple, si no tenemos la documentación que nos indique que es lo que hace y como lo hace, sería muy difícil y casi imposible entender y corregir errores de los sistemas.

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.

En la mayoría de los sistemas, la documentación esta siempre expresada en un carácter técnico por excelencia, indicando algoritmos de cómo realizar alguna acción, registrar transacciones, imprimir reportes, dependiendo de la naturaleza del sistema o su función.

También es necesario indicar que muchas veces no se le da el protagonismo que se merece, puesto que en la mayoría de los casos esta documentación es muy escasa o nula.

Entonces hay un punto en el que se discute la necesidad de contar con documentación que nos sea útil tras operar con el sistema y por otro lado vemos que esta documentación en mucho de los casos no existe.

Quizás, el problema se encuentre del lado de los desarrolladores, programadores y administradores del proyecto de sistema. Posiblemente no se este dando tanta importancia a una cuestión que como parte del proyecto conocen como se opera el sistema, saben todos sus por menores, errores, e interpreta cada dato que el sistema le proporciona, pero muchas veces se olvidan que ese sistema va a ser operado por personas ajenas al proyecto, personas que solo realizan tareas específicas y que necesitan del apoyo de “algo” que les indique ¿Qué hacer? Y obviamente ¿Cómo?

Hoy en la actualidad podemos encontrar estándares básicos de Documentación de sistemas, indicando su estructura, la forma de sus diagramas, la forma en la cuál deben ser narrados, etc.

Ahora entre los manuales que podemos realizar para los sistemas encontramos:

• Manual del Proyecto: Es aquí donde se encuentra las versiones del proyecto, análisis de las alternativas. Este manual tiene como finalidad apuntar a las altas gerencias o rangos más altos, y proveerles de la información necesaria y suficiente sobre un sistema en particular.

• Manual de Usuario: Aquí se expresa claramente los procesos que el usuario puede realizar con el sistema implementado. Permite a los usuarios conocer el detalle de que actividades ellos deberán desarrollar para la ejecución de los objetivos del sistema. Entonces su objetivo es claro, brindar al usuario un manual de aprendizaje, referencia, consulta para cada tarea que realice junto al sistema.

Puede que esta clasificación sea algo general y con visiones de sistemas diferentes pero complementarios, una enfocada en aspectos generales con detalles mínimos y precisos de implementación y diseño, y el otro ayuda a los operadores del sistema a realizar sus actividades diarias. ¿Cuál es más importante? Ambas, ¿Es necesario siempre que un proyecto de software contemple esta documentación? Siempre, ¿Existe herramientas que nos van a ayudar a documentar sistemas? Existen numerosas herramientas que acompañan el proceso de documentar.

Quizás también le interese:

• La importancia de los Comentarios en nuestros Códigos
• Documentación oficial de PHP
• Por que nunca documentamos nada
• Fecha para la primera RC de bacKardi