Séminaire: Alexandre Terrasa

Qui? Alexandre Terrasa, doctorant au LATECE sous la supervision de Jean Privat et Guy Tremblay Quand? Mercredi 20 mai 2015 à 12h15 Où? PK-4610

Titre

Vers une auto-documentation parfaite des API objets. Chapitre I: Structurer la documentation

Résumé

La documentation est un outil incontournable pour tout développeur souhaitant utiliser ou maintenir un composant logiciel. La production d’une documentation de qualité demande un effort considérable de la part de l’écrivain et les outils d’auto-documentation disponibles aujourd’hui tels Javadoc restent très limités face à cette problématique.

Dans le cadre des projets patrimoniaux du Latece, nous nous intéressons à la création d’un outil d’auto-documentation semi-automatique capable de générer une documentation parfaite pour un moindre effort. Cette présentation traitera du premier chapitre de notre étude visant à structurer adéquatement une documentation d’API pour la transformer en un manuel utilisateur facile à lire et à comprendre.

Au cours de cette présentation, nous aborderons les problèmes rencontrés durant notre étude, nous expliquerons notre méthodologie et les solutions envisagées. Nous verrons qu’il n’est pas si simple de proposer une solution parfaite et encore moins simple de valider une telle solution. Ce sera aussi l’occasion de partager vos attentes et vos idées sur ce que se devrait d’être l’outil idéal.

Slides

Comments are closed.