El apéndice contiene detalles de bajo nivel acerca
del sistema, que no son necesarios para comprenderlo en un nivel superior, pero
que se exigen para usarlo en la práctica o para verificar afirmaciones
realizadas en cualquier parte del documento.
- Formatos. Una descripción de todos los formatos adoptados o garantizados por el programa: para un fichero E/O (fichero para entrada y salida de datos), argumentos de la línea de comando, diálogos de usuario, formatos de los mensajes para las comunicaciones en red, etc. Éstos deberían desglosarse en formatos visibles para el usuario, que son parte conceptual de los requisitos visibles para el usuario y del manual de usuario, y en formatos interiores que constituyen una parte conceptual de otros componentes de su documentación.
- Especificaciones del módulo. Debería extraer las especificaciones de su código y presentarlas por separado aquí. Si escribe sus comentarios en el estilo aceptado por Javadoc con el doclet de 6.170 , podrá generar documentos de la especificación de forma automática a partir del código. La especificación de un tipo abstracto debería incluir su visión general, campos de la especificación e invariantes abstractas (restricciones de especificación). La función de abstracción y el invariante de representación no forman parte de la especificación de un tipo.
- Casos de prueba. Idealmente, su banco de pruebas lee tests de un archivo de casos de prueba en un formato que resulta cómodo de leer y escribir. No es necesario que incluya casos de prueba muy extensos; por ejemplo, simplemente podría observar el tamaño de una entrada aleatoria generada para realizar pruebas de estrés y proveer al programa que generó los tests. Indique cuál es la utilidad de cada grupo de tests (ej. "pruebas de estrés, entradas enormes", "pruebas de partición, todas las combinaciones de +/-/0 para argumentos enteros").
La documentaci{on del Software se refiere a todo lo concerniente a la documentación del propio desarrollo del software y de la gestión del proyecto, doumentación de requisitos pasando por modelaciones (UML),diagramas de casos de uso, pruebas, manuales de usuario, manuales técnicos, etc; todo con el propósito de eventuales correcciones, usabilidad, mantenimiento futuro y ampliaciones al sistema, y tener en cuenta que hay un buen sistema documentado que a la hora de ver y verificar esa documentaci{on sirve de guia y apoyo a otros expertos o no en sistemas.
ResponderEliminarLa documentación del software sirve como información escrita sobre definición de requerimientos, especificaciones generales del sistema, especificación de cada componente y los planes integrales de prueba y mantenimiento. Las herramientas de gestión de configuración también son de gran utilidad en la documentación del software y a su vez esta información posibilita la reproducción del software o su adaptación para mantenimiento. El tipo de información documentada suele valer muchísimo para la compañía de software o clientes puesto que podría perderse si no se documenta, ya que los desarrolladores van y vienen.
ResponderEliminarLa documentacion nos sirve de apoyo para conocer el sistema, partiendo del punto de vista donde la documento tiene un fin especifico, en el caso de definicion de requisitos, describe que se hace y como se hace, el documento de diseño se documeta la interfaz y ciertas especficaciones de arquitectura del software.. todo esto nos lleva a decir que es sirve de bitacora del software.. describiendo desarrollo hasta la implantacion del sistema, dejando como herramientas de ayuda el manual del sistema; lo que en conclusion hace eficiente la aplicacion de la Ingeneria de Software.
ResponderEliminarCuando hablamos de Documentación de Software, estamos hablando de todos los documentos que comprenden la creación y el mantenimiento de un software, no solo de su creación, sino que cada modificación de la misma, procede también a una transformación en la documentación cuando agregamos nuevos procesos, casos de uso, entre otros. La Documentación nos da el poder de saber los que hicimos a través del tiempo y estamos dejando una historial para futuros usuarios que manipularían o modificarían dicho software.
ResponderEliminarLa documentación es tan importante para los desarrolladores que mas adelante deberán realizar mantenimiento o actualizaciones a los sistemas ya que si el sistema esta bien documentado sera mucho mas fácil mencionados procesos y sobre todo si se trabaja en equipos grandes de mas de 3 personas con lo cual el proceso puede realizarse de forma modular.
ResponderEliminarla documentación sea recompensado incluso dentro de los límites de un pequeño proyecto, constituye una sorpresa para la mayoría de los novatos.
ResponderEliminarpondrá en duda decisiones que tomó durante el desarrollo del mismo. Si no documenta sus decisiones, se verá siempre cometiendo los mismos errores y tratando de comprender lo que pudo haber descrito fácilmente en una ocasión. La falta de documentación no sólo genera trabajo adicional, sino que también tiende a dañar la calidad del código. Si no posee una nítida caracterización del problema, es imposible que desarrolle una solución clara.
Aprender a documentar software es una tarea complicada y exige un criterio de ingeniería maduro. Documentar de forma concisa es un error habitual, pero el otro extremo puede resultar igual de perjudicial: si escribe documentaciones extensas, éstas atosigarán al lector y constituirán una carga a la hora de conservarlas. Es esencial documentar sólo los asuntos correctos. La documentación no sirve de ayuda para nadie si su extensión desanima a la gente a la hora de leerla.
Los principiantes tienen la tentación de centrar sus esfuerzos en temas sencillos, ya que éstos les resultan más fáciles de documentar. Esto es una pérdida de tiempo; no se aprende nada del esfuerzo y se termina escribiendo una documentación que es cualquier cosa excepto útil. Los principiantes también tienden a mostrarse reacios con los problemas de documentación. Esto trae consigo poca visión de futuro: si usted sabe que algún aspecto de su diseño no es del todo correcto, que alguna parte del problema no se ha aclarado o que es posible que parte del código tenga errores, ¡dígalo! Hará que el lector ahorre tiempo dándole vueltas a algo que aparentemente es erróneo, se acordará de dónde tiene que mirar si encuentra problemas y acabará teniendo una documentación más útil y honesta.
http://mit.ocw.universia.net/6.170/6.170/f01/related-resources/documentation.html
EliminarLa documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma, ya que ayudan a los usuarios y desarrolladores a comprender el software, asimismo, garantiza la reutilización de parte del programa en otras aplicaciones, sin necesidad de conocerse el código.
ResponderEliminarRepresenta una guía técnica o manual técnico donde se refleja el diseño del proyecto, la codificación de la aplicación y las pruebas realizadas para su correcto funcionamiento. El principal objetivo es el de facilitar el desarrollo, corrección y futuro mantenimiento de la aplicación de una forma rápida y fácil…
Todo proyecto de Software exitoso esta apoyado en una buena documentación.
ResponderEliminarLa documentación de software, es una herramienta muy importante ya que a través de ella las personas que no conocen el software pueden indagar en todo el material que sustenta al mismo. La documentación de los software es muy importante ya que los lectores se pueden nutrir de toda la información expuesta en la misma, siempre y cuando esta sea entendible o de fácil comprensión y no tome un papel fatigante para los que indagan en dicha documentación.
ResponderEliminarEste comentario ha sido eliminado por el autor.
ResponderEliminarEs Importante saber y que a la hora de programar un Sistema Informatico o cualquier otro producto, es necesario documentarlo ya que realizar este proceso garantiza a los usuarios poseer una gran ayuda cuando se presente cualquier eventualidad en la ejecusión del mismo. Por otra parte es preciso decir que es un trabajo no muy sencillo documentar y que se requiere de ingenio y experiencia para poder realizar una buena documentacion ya que esta no se debe realizar de manera rapida como para salir del paso porque se convierte en algo que a la final no sera de ayuda, al contrario se debe realizar una documentacion detallada y a su vez no extensa porque seria poco llamativa para guiarse de la misma.
ResponderEliminar