Séminaire: Projet Patrimonial – Jean Privat & Guy Tremblay

Présentation de M. Alexandre Terrasa, M. Jean Privat & M. Guy Tremblay, UQAM <br> Projet Patrimonial. Titre: Vers l’auto-documentation  »parfaite » de systèmes logiciels. Résumé: L’auto-documentation des API consiste à produire la documentation de façon automatisée grâce aux commentaires de modules, classes et propriétés contenus dans l’API. Aujourd’hui, les outils d’auto-documentation comme Javadoc ou Doxygen dépendent principalement de l’effort fourni par le développeur pour écrire les commentaires et se contentent de produire un catalogue des entités disponibles dans l’API. Un support peu didactique pour les futurs utilisateurs de la bibliothèque ou du framework. Nous nous proposons d’améliorer ces outils afin de tendre vers une meilleure auto-documentation à la fois pour le développeur qui écrit la documentation que pour l’utilisateur qui la lit. Nous définissons les critères de qualité qu’on peut attendre d’une telle documentation. En comparant les documentations générées de celles écrites manuellement, nous sélectionnons quatre axes de recherche: la structure, les exemples, la recherche et la navigation. Finalement, cette présentation dresse le cahier des charges d’un outil capable de produire une auto-documentation parfaite. Nous expliquons les étapes à venir du développement de cet outil et expliquons comment il sera possible de valider chaque étape.

Comments are closed.