Wenn Sie einige Zeit als Entwickler verbracht haben, mussten Sie sich wahrscheinlich an bestimmte Richtlinien halten, was die Dokumentation Ihres Codes angeht, oder Sie mussten sich damit auseinandersetzen, herauszufinden, was der Code von jemand anderem macht, lange nachdem dieser gegangen war, und oft mit wenig oder gar keiner Dokumentation.
Wie undokumentierter Code können auch Pipelines ohne Dokumentation für den nächsten Eigentümer schwer zu verstehen sein, vor allem, wenn Sie das Unternehmen erst Jahre später verlassen haben. Ich bin auf genau dieses Problem gestoßen, als ich eine Pipeline aktualisieren musste, die von einem ehemaligen Teammitglied erstellt worden war. Deshalb sollten Sie die verschiedenen Möglichkeiten zur Dokumentation Ihrer Pipelines überdenken.
Klare Pipeline-Namen verwenden
Beim Erstellen Ihrer Pipeline ist es einfach, die Pipeline unter dem Standardnamen zu speichern. Wenn es an der Zeit ist, sie außerhalb Ihres Entwicklungsbereichs freizugeben, sollte sie einen Namen haben, der klar angibt, wofür diese Pipeline gedacht ist.
Darüber hinaus sollten Sie eine standardisierte Benennungskonvention für Pipelines festlegen und diese Konvention für alle Pipelines und Ressourcen in Ihrem Unternehmen einheitlich beibehalten. Wenn Sie eine einfache Möglichkeit haben, zu erkennen, dass mehrere Pipelines miteinander verbunden sind, ohne alle öffnen zu müssen, wird es einfacher, wenn Sie diese Pipeline an einen anderen Ort verschieben müssen.
Umbenennen Ihrer Snaps
Ändern Sie die Beschriftung der Schnappschüsse, um die durchgeführte Aktion wiederzugeben.
Eine Pipeline mit nichts als Standardbeschriftungen auf Snaps sagt selten mehr aus, als dass Sie Daten von einem Ort gelesen, etwas mit ihnen gemacht und sie an einen anderen Ort geschickt haben. Geben Sie insbesondere an, was herausgefiltert, umgewandelt oder abgebildet wird und wozu Pipeline Execute eine Pipeline aufruft.
Hier sind zwei Versionen der gleichen Pipeline. Welche vermittelt ihren Zweck besser?
Namen der Eingabe- und Ausgabeansicht ändern
Wenn Sie Daten kombinieren oder aufteilen, können Sie einen Hinweis darauf geben, wofür die einzelnen Pfade gedacht sind, indem Sie die Namen der Ansichten ändern. Im obigen Abschnitt sendet der Router-Snap Daten an die Ansichten SSO oder Non-SSO. Wenn ich also die Pipeline validiere, kann ich leicht erkennen, ob das Konto, das ich betrachte, in einer Organisation mit SSO, ohne SSO oder in beiden ist.
Pipeline-Notizen hinzufügen
Die Pipeline-Notizen ermöglicht es Ihnen, der Pipeline benutzerdefinierte Haftnotizen hinzuzufügen. Sie können je nach Bedarf ein- oder ausgeblendet werden, und ein Symbol über der Funktionsschaltfläche zeigt Ihnen an, ob Notizen vorhanden sind, wenn Sie eine Pipeline öffnen.
Verwenden Sie die Registerkarte "Pipeline-Eigenschaften".
Dies ist in der Regel eine der am wenigsten genutzten Möglichkeiten, der Pipeline Notizen hinzuzufügen, wobei Pipeline-Notizen die bevorzugte Methode sind. Es ist eine großartige Möglichkeit, schnelle Anforderungen bereitzustellen, z. B. Verweise auf untergeordnete Pipelines oder erforderliche Dateien oder historische Informationen, z. B. das Team, für das die Pipeline erstellt wurde. Auch die Möglichkeit, auf externe Dokumentation zur Verwendung der Pipeline zu verweisen, hat sich als sehr nützlich erwiesen.
Dies sind die verschiedenen Möglichkeiten, wie Sie Ihre Pipelines dokumentieren können. Finden Sie heraus, welche für Sie am besten geeignet sind.
