La documentación de arquitectura y diseño

La documentación de arquitectura y diseño se utiliza con el fin de dar una visión general del sistema y su funcionamiento a su vez se explicar por qué se va a implementar de esa manera también la relación entre ellos, esta documentación se realiza en las primeras etapas del desarrollo y debe ser revisado a la hora de realizar un cambio en el software.

La documentación técnica se refiere a una especificación más detallada referente a datos más técnicos como es el código, los algoritmos y las interfaces se utiliza un lenguaje más técnico y debe ser escrita mientras se implementa y se desarrolla lo más apropiada es dejarla junto al código fuente manteniendo un orden con los comentarios marcados de modo especial . El ideal es usar un código unificado y que tenga los estándares del mercado también que sea analizable por programas generadores de documentación como lo son doxygen, robodoc, naturaldocs. Y que funcione con distintos lenguajes estas herramientas de documentación analizan el código y general la información en el formato deseado.

Otro método para documentar el software es usar un modelo conocido como Programación literaria el cual fue propuesto por Donald Knuth en este sistema el código está inmerso dentro de la documentación descriptiva la idea de este modelo es considerar un programa como texto para humano y no como normalmente hacemos es crear un conjunto de instrucciones que interprete el computador y realice lo que nosotros queremos. También hay documentación que no se debe presentar dentro del código como los documentos para los desarrolladores como directrices, como organizar el código, control de versiones.

Nos preguntamos porque es tan importante la documentación y simplemente se debe considerar su importancia porque es un requisito fundamental en un negocio comercial todo debe quedar claro y bien documentado donde el cliente lo solicita para informarse de cómo le daremos solución a su problema.

...