Si vous avez passé un certain temps en tant que développeur, vous avez probablement dû suivre certaines lignes directrices concernant la documentation de votre code ou vous avez dû essayer de comprendre ce que fait le code de quelqu‘un d‘autre longtemps après son départ et souvent avec peu ou pas de documentation.
Tout comme le code non documenté, les pipelines sans documentation peuvent être difficiles à comprendre pour le prochain propriétaire, en particulier si c‘est des années après votre départ de l‘entreprise. J‘ai été confronté à ce problème lorsque j‘ai dû mettre à jour un pipeline créé par un ancien membre de l‘équipe, alors pourquoi ne pas revenir sur les différentes façons de documenter vos pipelines.
Utiliser des noms clairs pour les pipelines
Lorsque vous créez votre pipeline, il est facile de l‘enregistrer avec le nom par défaut. Lorsqu‘il s‘agit de le partager en dehors de votre espace de développement, il faut lui donner un nom qui indique clairement à quoi il sert.
En outre, il convient d‘adopter une convention de dénomination pour les pipelines et maintenez cette convention de manière cohérente pour tous les pipelines et toutes les ressources de votre organisation. Le fait d‘avoir un moyen facile de savoir que plusieurs pipelines sont connectés sans avoir à ouvrir tout le monde facilitera le déplacement de ce pipeline vers un autre endroit.
Renommer vos photos
Modifier les étiquettes Snap pour refléter l‘action entreprise.
Un pipeline qui ne comporte que des étiquettes par défaut sur les Snaps indique rarement autre chose que le fait que vous avez lu des données à un endroit, que vous leur avez fait subir un traitement et que vous les avez envoyées à un autre endroit. En particulier, indiquez ce qui est filtré, transformé ou mis en correspondance et ce que Pipeline Execute demande à un pipeline de faire.
Voici deux versions du même pipeline. Laquelle transmet le mieux son objectif ?
Modifier les noms des vues d‘entrée et de sortie
Chaque fois que vous combinez des données ou que vous les divisez, vous pouvez donner une indication de ce à quoi sert chaque chemin en changeant les noms des vues. Dans la section ci-dessus, le Router Snap envoie des données aux vues SSO ou Non-SSO, donc si je valide le pipeline, je peux facilement voir si le compte que je regarde est dans une organisation avec SSO, sans SSO, ou dans les deux.\N- Le Router Snap envoie des données aux vues SSO ou Non-SSO.
Ajouter des notes sur les pipelines
Les Notes sur le pipeline vous permet d‘ajouter des notes autocollantes personnalisées au pipeline. Elles peuvent être masquées ou affichées selon les besoins, et une icône au-dessus du bouton de la fonctionnalité vous permet de savoir si des notes existent lorsque vous ouvrez un pipeline.
Utiliser l‘onglet Info sur les propriétés du pipeline
C‘est l‘une des façons les moins utilisées d‘ajouter des notes au pipeline, les notes de pipeline étant la méthode préférée, mais je l‘ai trouvée particulièrement utile lors de l‘élaboration de notre catalogue de modèles. C‘est un excellent moyen de fournir des exigences rapides, comme le référencement des pipelines enfants ou le fichier requis, ou des informations historiques, comme l‘équipe pour laquelle le pipeline a été construit. La possibilité de créer un lien vers de la documentation externe sur la façon d‘utiliser le pipeline s‘est également avérée très utile.
Voilà les différentes façons de documenter vos pipelines. Trouvezcelles qui vous conviennent le mieux.
