Vers une approche integree de documentation des cadres d'applications

Abstract

Application frameworks are a new technology of object oriented paradigm. They constitute an important improvement in software development. Unfortunately, their use is still difficult because of the lack of documentation. The conventional approach of documentation does not respond neither to the needs of object oriented software nor to the application frameworks. We propose in this thesis a new integrated approach of documentation, based on literate programming and the idea of decomposition into atomic tasks.

During the project, we used Java language and the documentation tool of literate programming, Javadoc. To explore and validate our approach, we have adopted two application frameworks: AWT for user interface and JMAPI for network management. We devised a catalog of atomic tasks for both of the frameworks, then we documented with respect to Javadoc standard.

Our experience with the integrated approach of documenting application framework, allowed us to explore the maximum potential of reused components. Furthermore, validations on application frameworks specific to several domains proved that our documentation approach can easily be generalized. Finally, we establish a suggestion list to extend Javadoc, to improve the documentation quality and to optimize data access.

Abstract (AI English translation)

Information popover about translation disclaimer

Les frameworks d'applications sont une nouvelle technologie de paradigme orienté objet. Ils constituent une amélioration importante dans le développement de logiciels. Malheureusement, leur utilisation reste encore difficile à cause du manque de documentation. L'approche conventionnelle de la documentation ne répond ni aux besoins des logiciels orientés objet ni aux frameworks applicatifs. Nous proposons dans cette thèse une nouvelle approche intégrée de la documentation, basée sur la programmation alphabétisée et l'idée de décomposition en tâches atomiques.

Au cours du projet, nous avons utilisé le langage Java et l'outil de documentation de programmation littéraire, Javadoc. Pour explorer et valider notre approche, nous avons adopté deux frameworks d'application : AWT pour l'interface utilisateur et JMAPI pour la gestion du réseau. Nous avons conçu un catalogue de tâches atomiques pour les deux frameworks, puis nous l'avons documenté par rapport au standard Javadoc.

Notre expérience avec l’approche intégrée de documentation du cadre d’application nous a permis d’explorer le potentiel maximum des composants réutilisés. De plus, des validations sur des frameworks applicatifs spécifiques à plusieurs domaines ont prouvé que notre approche documentaire peut facilement être généralisée. Enfin, nous établissons une liste de suggestions pour étendre Javadoc, améliorer la qualité de la documentation et optimiser l'accès aux données.