Présentation de la outils documentaires

Objectifs

A l'issue de ce stage, les stagiaires seront en mesure de :

  • Créer et organiser un maven site
  • Publier un maven site via une connexion ssh
  • Utiliser plantuml
  • Mobiliser leurs connaissances en informatique afin de générer de la documentation automatiquement

Afin de maîtriser parfaitement l'utilisation d'un maven site, il sera nécéssaire de poursuivre les travaux engagés lors de l'accompagnement après le déroulement de celui-ci

Présentation

Le plugin maven-site permet de créer des sites web de documentation de qualité rapidement.

PlantUml est un outil permettant de créer des diagrammes UML au format texte.

Coupler ces deux outils permet d'obtenir un site documentaire permettant de comminiquer efficacement sur le travail réalisé par une application

Participants et prérequis

Cette formation s'adresse aux développeurs java voulant mettre en place un site documentaire. Afin de suivre cette formation, il faudra :

  • Avoir préparé le plan (partiel) du site à créer
  • Savoir quels outils et quels plugin seront utilisés
  • Avoir préparé quelques élements à utiliser lors de la formation : images à intégrer, modèles de diagrammes
  • Avoir un espace de publication du site
Programme

Partie 1 : Mise en place (1h15)

  1. Création d'un projet
    1. Déclaration du plugin dans le pom.xml.
    2. Configuration du serveur de publication.
  2. Configuration du projet
    1. Création de l'arborescence du site.
    2. Configuration du contenu (à faire par le stagiaire grâce à la documentation en ligne)
  3. Création de pages doxia (à faire par le stagiaire grâce à la documentation en ligne)

Partie 2 : Intégration de plantuml (45min)

  1. Installation
  2. Création des premier diagrammes (à faire par le stagiaire grâce à la documentation en ligne)
  3. Génération et intégration au maven-site

Partie 3 : Génération automatique (30min)

  1. Outils permettant de générer du code doxia
  2. Génération du dictionnaire de données