Création de la documentation du projet
Pour créer la documentation du projet, procédez comme suit :
Etape |
Action |
---|---|
1 |
|
2 |
Sélectionnez la vue de documentation. |
3 |
Sélectionnez les objets à inclure ou à exclure ( ou ). |
4 |
|
5 |
|
6 |
|
7 |
Vérifiez les paramètres dans l'aperçu avant impression. |
8 |
Ouverture de la structure de documentation
Pour ouvrir la structure de documentation, procédez au choix comme suit :
Double-cliquez sur le répertoire
dans le navigateur du projet.Cliquez avec le bouton droit sur le répertoire
, puis cliquez sur .
Sélection de la vue de la documentation
Lorsque la structure de documentation est ouverte, vous pouvez choisir entre les modes Vue structurelle et Vue fonctionnelle.
Ajout d'un objet dans la documentation
Pour inclure un objet dans la documentation, procédez au choix comme suit :
Dans la structure de documentation, cliquez avec le bouton droit sur l'objet à inclure, puis cliquez sur
.Dans la structure de documentation, sélectionnez l'objet à inclure et cliquez sur
.Dans la structure de documentation, cliquez avec le bouton droit sur le symbole d'objet pour basculer entre
et .
Les objets inclus dans la documentation sont identifiés par un symbole rouge placé en regard.
Suppression d'un objet de la documentation
Pour exclure un objet de la documentation, procédez au choix comme suit :
Dans la structure de documentation, cliquez avec le bouton droit sur l'objet à exclure, puis cliquez sur
.Dans la structure de documentation, sélectionnez l'objet à exclure et cliquez sur
.Dans la structure de documentation, cliquez avec le bouton droit sur le symbole d'objet pour basculer entre
et .
Ajout de tous les objets dans la documentation
Pour inclure tous les objets dans la documentation, procédez aux choix comme suit :
Dans la structure de documentation, cliquez avec le bouton droit sur le projet, puis cliquez sur
.Dans la structure de documentation, sélectionnez le projet et cliquez sur
.Dans la structure de documentation, cliquez sur le symbole du projet pour basculer entre
et .
Les objets inclus dans la documentation sont identifiés par un symbole rouge placé en regard.
Suppression de tous les objets de la documentation
Pour exclure tous les objets de la documentation, procédez au choix comme suit :
Dans la structure de documentation, cliquez avec le bouton droit sur le projet, puis cliquez sur
.Dans la structure de documentation, sélectionnez le projet et exécutez la commande
.Dans la structure de documentation, cliquez sur le symbole du projet pour basculer entre
et .
Mise à jour et préparation
A chaque modification dans le répertoire du projet, la documentation est automatiquement mise à jour.
Après chaque mise à jour, les objets modifiés ou nouveaux sont repérés par le signe (?).
Pour préparer le projet à l'impression, procédez au choix comme suit :
Dans la structure de documentation, cliquez avec le bouton droit sur le projet, puis cliquez sur
.Dans la structure de documentation, sélectionnez le projet et cliquez sur
.
Si les objets sont correctement préparés, le nombre de pages (n) apparaît après l'objet.