Lectura 9

Herramientas de documentación ágiles.

Introducción:
La importancia de la documentación en proyectos de software es indispensable, así mismo
existen herramientas y sistemas que pueden ser empleadospara realizar un trabajo más
productivo a la hora de documentar un proyecto, la documentación puede diferenciarse en
varios tipos de acuerdo al público y al contenido de la misma. A continuaciónveremos los tipos
de documentación, la importancia de documentar, los tipos de marcado y algunas de sus
características.
Resumen:


Tipos de documentación:
1. Documentación de arquitectura y diseño: Nosdan una idea previa de cómo se va a
realizar el proyecto y explica por qué realizarlo de tal manera, suele realizarse en las
etapas iniciales, se debe enumerar los componentes a emplear y su respectivajustificación, la funcionalidad y la relación entre ellos.
2. Documentación técnica: Aquí se documenta el código, algoritmos, interfaz esta se
escribe mientras se implementa, hay dos maneras derealizar el código y la
documentación en conjunto. Una es usando un formato analizable, herramientas
que analizan el código y generan un documento como formato de salida. Y la
segunda es la programaciónliteraria, este sistema incluye el código fuente en el
código descriptivo, se basa en un texto para seres humanos en lugar de
instrucciones para ordenador. Sin embargo este tipo de documentación técnicatambién incluye otros documentos que si deben realizarse por separado a la
codificación dado el caso de cómo organizar el código, comentar y documentar el
código entre otras.
3. Documentación deusuario final: Como su nombre lo indica es la entregada al
usuario final, y describe cómo usar los programas y puede ser escrita por personas
ajenas al desarrollo del proyecto.



Importancia de ladocumentación:
1. Como requisito del cliente, para un proyecto comercial donde se encuentren los
componentes y fases del proyecto.
2. Para ver la relación e interacción de los subsistemas, bastante útil...