<< Back

Comment documenter un workflow Alteryx ?

La documentation d’un workflow sur Alteryx est une partie importante et non négligeable ! C’est un processus qui peut prendre du temps et il est conseillé de la faire au fur et à mesure du développement et de la construction du workflow.

Découvrez nos conseils pour documenter votre workflow Alteryx et apporter confort et lisibilité à vos futurs utilisateurs !

Pourquoi documenter son workflow Alteryx ?

Une bonne documentation permet de détailler les différentes étapes du workflow, d’expliquer ce qui est réalisé dans les outils, mais aussi d’apporter de la compréhension aux futurs utilisateurs.

La documentation peut également être d’une grande utilité pour donner du contexte lorsque nous devons optimiser ou enrichir un workflow que nous avons réalisé plusieurs semaines, voir plusieurs mois après sa publication.

Elle devient essentiel lorsqu’un nouvel utilisateur va devoir reprendre le travail effectué par son prédécesseurs et permet, dans ce cas présent, un gain de temps et de qualité considérable !

Quelles sont les bonnes pratiques de documentation ?

Il existe un grand nombre de bonnes pratiques de documentation dans Alteryx Designer que nous allons détailler dans la suite de cet article. Vous pourrez également les mettre en place sur Alteryx Server en suivant les conseils de cet article.

Donner un titre à son workflow

Le titre de votre workflow est très important, car c’est une des premières informations à laquelle l’utilisateur va avoir accès. Il doit être clair et donner un aperçu exhaustif de l’objectif de votre workflow.

Pour cela, vous pourrez utiliser l’outil « Commentaire » afin d’indiquer et de personnaliser votre titre. Ainsi, il sera possible de choisir la forme de l’outil, mais aussi le type, la taille ou bien la couleur de la police d’écriture. Vous pourrez également choisir la couleur de l’arrière-plan ou encore l’alignement de votre texte.

Rappeler les informations clés

Un workflow peut contenir beaucoup d’étapes, d’outils voir des opérations complexes. C’est pourquoi, il est important de rappeler quelques informations clés dès le début.

  • L’objectif du workflow
  • La durée d’exécution
  • La date à laquelle de conception du workflow et quelle version d’Alteryx Designer a été utilisée
  • Le nom et les coordonnés du développeur
  • Les différentes étapes d’exécution du workflow
  • Les sources de données utilisées
Exemple de documentation d'un workflow Alteryx Designer
Ci-dessus, un exemple de documentation que vous pouvez appliquer sur vos workflows

Décomposer les étapes de création

Décomposer son workflow en plusieurs va permettre d’apporter plus de clarté sur son objectif. En utilisant les conteneurs dans Alteryx Designer, vous allez pouvoir naviguer plus facilement en recherchant du texte : Modifier > Rechercher ou Ctrl+F.

Utilisation des conteneurs pour améliorer la documentation d'un workflow Alteryx

Regrouper les outils par catégories

Dans le but d’apporter une meilleure compréhension visuelle et gagner du temps, n’hésitez pas à regrouper vos outils dans différents conteneurs et catégories. En effet, vous pouvez regrouper en plusieurs catégories et par couleurs vos outils d’entrées de données, de préparation, de jointure…

Utilisateur des conteneurs pour la documentation d'un workflow Alteryx

De plus, pour optimiser le confort visuel de votre workflow, vous avez la possibilité d’aligner rapidement vos outils ou conteneurs. Pour cela, il vous suffit de sélectionner un groupe d’outils ou de conteneurs faire un clic droit et choisir l’option « Aligner horizontalement » ou « Aligner verticalement ».

Alignement des outils pour la documentation d'un workflow Alteryx

Utiliser la documentation interne dans Alteryx Designer

Afin de savoir comment a été paramétré un outil, mais sans ouvrir les paramètres de configurations, vous pouvez utiliser des annotations. Il est possible d’ajouter une annotation à un outil en cliquant dessus, puis dans la fenêtre de configurations en sélectionnant le logo « Annotations ».

Utilisation des annotations pour documenter les outils utiliser dans le workflow

En plus des annotations, certains outils peuvent contenir de la documentation supplémentaire. C’est par exemple le cas pour les outils Formule, Filtrer, Sélectionner. Dans les outils Formule et Filtrer, vous pouvez rajouter un commentaire en précédant votre texte de // ou en l’encadrant dans /*Texte*/.

Documentation de l'outil Formules dans Alteryx Designer

L’outil Sélectionner peut quant à lui contenir une description dans la colonne « Description » des configurations de l’outil.

Exemple final de documentation d’un workflow Alteryx

Quelques astuces supplémentaires

Voici quelques astuces de documentation supplémentaires:

  • Changer le fond de votre Canevas. En allant dans Options > Paramètres utilisateur > Modifier les paramètres utilisateurs, une nouvelle fenêtre s’ouvre, choisissez Canevas. Vous avez la possibilité de choisir la couleur d’arrière-plan, faire apparaître une grille de la couleur de votre choix, définir sa taille.
  • Rendre vos connexions sans fil. Si un de vos outils contient beaucoup de connexions et qu’elles compromettent l’esthétique de votre workflow, vous avez la possibilité de les rendre invisible. Pour ce faire, cliquez sur un outil ou une connexion et sélectionner « Rendre la connexion sans fil ».

    Les outils possédant cette option seront alors signalés avec un logo s’apparentant à des paraboles. Il ne faut cependant pas abuser des connexions sans fil, car elles peuvent perturber le développeur dans la compréhension de l’interaction entre les différents outils.
Connexion sans fil dans Alteryx Designer
  • Grâce à l’outil Navigateur, vous pouvez intégrer dans votre workflow des pages web. Pour cela, il suffit de rentrer dans les configurations de l’outil l’URL du site en question. Vous pouvez également rentrer un chemin sur votre PC pour afficher les fichiers dans un de vos dossiers.

Alteryx Designer, comment progresser ?

Vous êtes désormais un pro de la documentation de vos workflow dans Alteryx Designer ! Découvrez d’autres articles de The Information Lab en vous rendant sur notre blog.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée.