Documentacin de software"La documentacin de un proyecto de software es una parte esencial de las actividades que se deben realizar para el correcto desarrollo, implementacin y mantenimiento del mismo." Nosotros pensbamos que no necesitbamos documentar nada, porque utilizbamos metodologas giles,pero el sistema fue creciendo y hemos perdido el control (control se acompaa de se fue un desarrolladory no sabemos como hizo parte del sistema, o de tenemos parte del desarrollo externalizado a una empresa y no sabemos que han hecho, por lo que no podemos prescindir de ellos, o de integramos nuestro software con el de otra empresa, y no sabemos donde acaba un producto y empieza el otro, etc.)DefnicinSonmanualestcnicos,manualesyotras instruccionesquefacilitanelusoyel funcionamientodeunproductooserviciosde softwareconstituyenladocumentacindel software.Estadocumentacinpuedeincluirensu caso,elcdigofuente,loscdigosdeerrorysus signifcados. La documentacin del software puede existirtambinenformatoelectrnico,enformato !" , como un #! o un libro.Documentacin en cada faseTipos de documentacinDocumentacin del usuarioLadocumentacinparaelusuarioconstituyeunelementode consultaparatodaaquellapersonaquevaausarelprograma porprimerave$oquetratadesabersielprogramaservir%a susob&etivos.'gualmentees(tilparausuariosqueyareali$an unmane&ob%sicoyquierenprofundi$ar)aciaunconocimiento avan$ado. *na documentacin completa contendr+a, ortada con el nombre del programa, versin y autor o autores. -ndice. !escripcin muy breve de las funciones y posibilidades del programa. !escripcin breve del mtodo de c%lculo principal. Explicacin breve de cmo debe usarse el programa y de los datos de entrada, opciones y resultados. E&emplos paso a paso de uso del programa en n(mero sufciente para comprender las posibilidades que se brindan. !iagrama de .u&o del programa de car%cter sinttico y descriptivo. Especifcacin detallada de todas las opciones contenidas en men(s. Especifcacin detallada de todos los c%lculos, principales y secundarios.Tipos de documentacinDocumentacin para el mantenimientoLa documentacin para mantenimiento constituye el elemento de referencia para el programador que )aya de reali$ar cambios o ampliaciones del programa en el futuro. La necesidad de mantenimiento deriva de,/ !efectos del programa no detectados y que es necesario corregir./ #ambios externos de +ndole pol+tica, tcnica, social, etc. que afectan al programa, normativa, moneda, novedades de un sistema operativo, etc./ Solicitudes de los clientes o usuarios.El mantenimiento de un programa puede darse en,-!ise1o b%sico-"unciones importantes pero desligadas del n(cleo del programa-#uestiones meramente estticas. El mantenimiento debe considerarse como programacin en todos sus sentidos y es ideal un mantenimiento que respete la flosof+a y el estilo del programa que se mantiene, de modo que un auditor no pudiera detectar qu parte del programa corresponde al cdigo original y qu parte a la ampliacin o correccin.Una documentacin de mantenimiento completa puede contener: ortada, n(mero de versin, autor. -ndice. 2b&eto y aspectos principales del programa. !iagrama de .u&o modular. !iagrama de .u&o para cada mdulo, desarrollado y con enfoque a las variables y procesos internos. #digo completo del programa. Explicacin de la gestin de errores del programa. Esquema o +ndice descendente del programa, actuali$ado. Explicacin de variables, datos, arc)ivos. 3ecomendaciones para el mantenimiento futuro. #ualquier informacin que se considere relevante para un programador que )aya de traba&ar con el programa.Las 5 claves para una documentacin exitosa!4 5omado de 5)e6eys tosuccesful software documentation, 7lue8ango Learning systemsComienza con el fnal en mente!ensando como los usuarios utili$aran tu documentacin antes de empe$ar a escribir te dar% una me&or visin y podr%s estructurar con mayor agilidad tu contenidoCrea en pedazos pequeos! #uando utili$as este enfoque,el nmero de artculos de ayuda crecer mientras que el tiempo para crearlos disminuir. 9sea que crearas m%s contenido en menos tiempoMuestra no di!as!-#laridad-7revedad-:elocidad"ne tu documentacin con velcro # no con cemento!"sa procesos no pro#ectos-5iempo de planeacin m%s corto-!esarrollo r%pido-;ctuali$aciones incrementales$ctividades propuestas

?.'nvestigaelest%ndar'EEE