Création de la documentation du projet

Pour créer la documentation du projet, procédez comme suit :

Etape

Action

1

Ouvrez la structure de documentation.

2

Sélectionnez la vue de documentation.

3

Sélectionnez les objets à inclure ou à exclure (Inclure la rubrique ou Exclure la rubrique ).

4

Configurez la page d'impression.

5

Définissez les paramètres d'impression.

6

Préparez les objets à imprimer.

7

Vérifiez les paramètres dans l'aperçu avant impression.

8

Sélectionnez une imprimante et lancez l'impression.

Ouverture de la structure de documentation

Pour ouvrir la structure de documentation, procédez au choix comme suit :

  • Double-cliquez sur le répertoire Documentation dans le navigateur du projet.

  • Cliquez avec le bouton droit sur le répertoire Documentation, puis cliquez sur Ouvrir.

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 Inclure la rubrique.

  • Dans la structure de documentation, sélectionnez l'objet à inclure et cliquez sur Edition > Inclure la rubrique.

  • Dans la structure de documentation, cliquez avec le bouton droit sur le symbole d'objet pour basculer entre Inclure la rubrique et Exclure la rubrique.

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 Exclure la rubrique.

  • Dans la structure de documentation, sélectionnez l'objet à exclure et cliquez sur Edition > Exclure la rubrique.

  • Dans la structure de documentation, cliquez avec le bouton droit sur le symbole d'objet pour basculer entre Inclure la rubrique et Exclure la rubrique.

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 Inclure toutes les rubriques.

  • Dans la structure de documentation, sélectionnez le projet et cliquez sur Edition > Inclure toutes les rubriques.

  • Dans la structure de documentation, cliquez sur le symbole du projet pour basculer entre Inclure toutes les rubriques et Exclure toutes les rubriques.

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 Exclure toutes les rubriques.

  • Dans la structure de documentation, sélectionnez le projet et exécutez la commande Edition > Exclure toutes les rubriques.

  • Dans la structure de documentation, cliquez sur le symbole du projet pour basculer entre Inclure toutes les rubriques et Exclure toutes les rubriques.

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 Générer la documentation.

  • Dans la structure de documentation, sélectionnez le projet et cliquez sur Edition > Générer la documentation.

Si les objets sont correctement préparés, le nombre de pages (n) apparaît après l'objet.

NOTE : tous les objets sont prêts dès qu'un nombre de pages s'affiche en regard de l'objet du projet.
NOTE : lors de la préparation à l'impression, des documents imprimables sont générés pour chaque objet. Par défaut, la documentation n'est pas sauvegardée. Elle est supprimée à la fin de la session Control Expert et doit être regénérée à la session suivantede Control Expert. Si vous souhaitez utiliser ces documents dans d'autres sessions, cochez la case Sauvegarder la documentation générée dans la boîte de dialogue Configuration de l'impression.