Jobs de documentation

Objective

After completing this lesson, you will be able to écrire des commentaires avec des descriptions et des annotations

Descriptions et annotations

Les descriptions et les annotations sont un moyen pratique d'ajouter des commentaires aux objets et aux diagrammes d'espace de travail.

Cela peut être utile si vous avez besoin de partager la conception du projet ou si vous voulez simplement avoir une idée claire de ce à quoi chaque objet est destiné et vous donner un moyen de vérifier que vous avez atteint votre objectif.

En fonction de ce que vous expliquez et de l'endroit où vous voulez que l'explication apparaisse, vous pouvez ajouter des descriptions ou des annotations.

  • Les descriptions sont liées à un objet spécifique et peuvent apparaître dans des diagrammes où l'objet est affiché, mais également dans la bibliothèque d'objets locale.
  • Les annotations ne sont que des notes adhésives indépendantes qui n'apparaissent que dans les diagrammes.

Utilisation de descriptions avec des objets

Une description est associée à un objet particulier. Vous pouvez le saisir en affichant la boîte de dialogue des propriétés de l'objet.

Elle apparaîtra dans la liste Bibliothèque d'objets locale.

Lorsqu'un objet du référentiel est importé et exporté, la description est également importée ou exportée.

Un concepteur de flux de données détermine quand afficher les descriptions d'objets dans les diagrammes en fonction d'un paramètre au niveau du système et d'un paramètre au niveau de l'objet. Les deux options doivent être activées pour afficher la description d'un objet particulier.

Remarque

L'option au niveau du système est unique à la configuration.

Conditions requises pour l'affichage des descriptions dans les diagrammes

  • Une description a été saisie dans les propriétés de l'objet.
  • La description est activée sur les propriétés de cet objet.
  • L'option globale Afficher les descriptions d'objets activés est activée.

Remarque

L'option Descriptions activées est disponible uniquement lorsqu'au moins un objet est présenté dans l'espace de travail.

Utilisation d’annotations dans les diagrammes

Une annotation est un objet de type sticky-note dans l'espace de travail. Une annotation est associée au diagramme d'objets où elle apparaît.

Lorsqu'un job, workflow ou flux de données est importé ou exporté, et qu'il inclut des annotations, les annotations associées sont également importées ou exportées.

Je vais vous montrer comment ajouter des descriptions et des annotations :