El jueves pasado fuí depurando un script que sirve para generar un paquete de uno de los proyectos que hemos desarrollado en la empresa, entre los compañeros lo llamamos el 'busines'. Su tarea es mantener un cierto control sobre los asistentes a la comida de negocios que organiza Marqueze Telecom cada 6 meses, que se está volviendo un clásico en su pantalla amiga.
El objetivo del script es simple, recoger el código fuente, generar su ChangeLog, generar la documentación de clases y meterlo en un fichero comprimido. Nada más, ni nada menos.
Desde el primer momento, fuimos documentando las clases del sistema con el formato phpDoc (basado en JavaDoc) que nos dá una idea de todo lo que hay por dentro. Faltan unos detalles, como los propios diagramas UML, ERD y algún que otro documento de requisitos y casos de uso, que no se pueden hacer de forma automática y que con tiempo se harán. Justamente, esos documentos son los primeros que se hacen, pero nunca es tarde si la dicha es buena.
Bueno, la idea de hacer algo así comenzó es una mezcla de varios factores:
Además: ¿No se nota que estoy estudiando ahora mismo Ingeniería del Software y me preocupan [más] todos estos aspectos tan 'extraños'?
El objetivo del script es simple, recoger el código fuente, generar su ChangeLog, generar la documentación de clases y meterlo en un fichero comprimido. Nada más, ni nada menos.
Desde el primer momento, fuimos documentando las clases del sistema con el formato phpDoc (basado en JavaDoc) que nos dá una idea de todo lo que hay por dentro. Faltan unos detalles, como los propios diagramas UML, ERD y algún que otro documento de requisitos y casos de uso, que no se pueden hacer de forma automática y que con tiempo se harán. Justamente, esos documentos son los primeros que se hacen, pero nunca es tarde si la dicha es buena.
Bueno, la idea de hacer algo así comenzó es una mezcla de varios factores:
- Puro capricho pelusil, influido en ciertos recuerdos amargos de cuando he tenido que enfrentarme a otro tipo de aplicaciones, en los que era imposible disponer de algo (el paquete) que incluyera el código fuente de la aplicación como la documentación de la misma.
- Hacer mejor el trabajo, al menos en la medida de lo posible (es una lucha continua, siempre se puede mejorar).
- Quizás se publique el código, pero ya se verá.
Además: ¿No se nota que estoy estudiando ahora mismo Ingeniería del Software y me preocupan [más] todos estos aspectos tan 'extraños'?
No hay comentarios:
Publicar un comentario