02/10/2007, 13:51
| ||||
| ||||
| Como documentar una aplicacion. Hola. Ando buscando algunas indicaciones sobre como documentar una aplicacion que ya esta creada. Haber si me explico, desarrolle una aplicacion y ahora quieren que la documente de tal manera que si el dia de mañana llega otro desarrollador a hacer mantenimiento a la aplicacion lo haga sin problemas y que entienda la aplicacion falcilmente. Pero no se si hay standares o documentos guia para este proceso. ¿Alguien sabe algo al respecto? Gracias.
__________________ Si mi respuesta te ha ayudado, agradezco que me regales unos puntos de Karma XD. "Una mujer sería encantadora si uno pudiera caer en sus brazos sin caer en sus manos." (Ambrose Bierce) |
|
03/10/2007, 12:16
| |||
| |||
| Re: Como documentar una aplicacion. Hola No he visto mucho material en la web sobre esto. Pero lo que se debería hacer es documentar primero antes de programar que es lo que debe hacer la aplicación, de ese modo ya haces un analisis antes de programar, porque sino programas y luego te das con que no era lo que querías. Generalmente se documenta lo que hace el formulario y no tanto el código de programación. Realmente es largo el tema y para discutirlo, pero en una empresa agarrabamos un documento y hacíamos algo así para al ABM de empleados. EVENTO INICIAR. ---------------------- 1- Muestro el último registro cargado si hay registro. 1.A- Desactivo todos los botones, solo activo botón "Nuevo" y "Modificar" y "Buscar". 2- No existen registro cargados, solo activo botón "Nuevo". ..... ..... ..... EVENTO GRABAR --------------------- 1- Valido que los campos obligatorios estén completos. 1.A - Todos los campos son correctos. Guardo datos en la base 2 - El campo fecha no es correcto. Muestro mensaje de error. .... .... .... EVENTO MODIFICAR -------------------------- .... .... EVENTO ELIMINAR ------------------------- .... .... .... Esa sería más o menos la idea. Que tengas un documento por ABM o formulario en el que describas paso a paso que hace el formulario. En cada paso podes poner todos los caminos que existen. Por ejemplo un camino es si los datos son correctos, otro es si los datos son incorrectos y así. Saludos
__________________ PD: Con amor, fe, amor a Dios y amistad podemos hacer un mundo mejor!!!! |
|
03/10/2007, 21:02
| ||||
| ||||
 Como documentar una aplicacion. Hola, creo que en resumen lo que debes hacer es describir el Ciclo de Vida de un Sistema de Información Hay bastante informacion aca un link. http://www3.uji.es/~mmarques/f47/apun/node66.html Espero que te ayude Saludos Atte Atak 
__________________ . .: El mejor Inicio :. . |
|
04/10/2007, 04:02
| ||||
| ||||
| Re: Como documentar una aplicacion. Yo hago similar a lo que dice Trulala. Ya no porque tenga que enseñarla a otro programador sino por uno mismo. ¿como te acuerdas de todo cuando tienes varias app? Cojo un documento Word y voy detallando las clases / formularios(esquemáticamente). Básicamente detallo qué debe hacer (su función), consideraciones previas a la ejecución y consideraciones post ejecución. A parte en otro Word pongo todas las tablas con sus respectivos campos, y todo la info relevante de ésta (tipo campo, tamaño, key, definición, etc.) A grandes rasgos eso. Lo que también ayuda a los siguientes programadores es poner explicaciones en el código propio. Algo así te puede servir para guiarte: Guía de Módulos FacturaLUX 1.9 http://www.abcdatos.com/tutoriales/tutorial/z5214.html saludos |
