Bonjour à tous,

Nous avons le plaisir de vous inviter au troisième séminaire du LATECE de l'année universitaire 2018-2019.

Qui ? Alexandre Terrasa, Doctorat informatique, sous la direction des professeurs Jean Privat et Guy Tremblay , département informatique, uqam

Quand ? Mercredi 28 novembre 2018 à 12h30 

Où ? PK 5115

Titre :

AUTO-DOCUMENTATION ASSISTÉE DE LOGICIELS : GÉNÉRATION ET MAINTENANCE DE FICHIERS README AVEC L’OUTIL NITREADME.

Résumé : 

Le fichier readme est typiquement le premier artefact de documentation vu par les utilisateurs d’un projet logiciel — sa page de couverture. Ce fichier permet de présenter les objectifs d’un logiciel, ses fonctionnalités, son utilisation, etc. Selon une étude empirique que nous avons réalisée sur GitHub, la plate-forme de partage de code la plus populaire au monde, 99% des projets contiennent un tel fichier.

Les fichiers readme sont écrits selon une structure et un ordre plus ou moins standardisés, et notre étude montre que certaines sections sont communes à la plupart, par ex., installation, signalement de bogues, licence, etc. Étrangement, une part importante des informations rédigées à la main pour la présentation des API — par ex., listes de classes et de propriétés, documentation de ces entités, exemples d’utilisation — correspond à ce qui est habituellement produit de manière automatisée par les outils d’auto-documentation d’API tels que Javadoc ou Doxygen.

Nous proposons donc une approche permettant d’assister l’écrivain de fichiers readme, tant durant la rédaction que la maintenance. Lors de la rédaction, notre approche consiste à suggérer des cartes de documentation, i.e., des extraits de documentation produits par le générateur de documentation d’API pouvant être importés directement dans le corps du readme. Puis, durant la maintenance, notre approche assure que le contenu de ces cartes soit tenu synchronisé avec le code source.