Freigeben über

Bereitstellung von Benutzerdokumentation für Ihren benutzerdefinierten Connector

  • Artikel

Nachdem Sie den Entwurf Ihres Data Factory-Connectors abgeschlossen haben, müssen Sie einen Artikel übermitteln, der Anweisungen zur Verwendung Ihres Connectors für die Veröffentlichung in Microsoft Learn enthält. In diesem Artikel geht es um das Layout eines solchen Artikels und um die Formatierung des Textes Ihres Artikels.

Artikel-Layout

In diesem Abschnitt wird das allgemeine Layout der Connector-Artikel beschrieben. Ihr Connector-Artikel sollte diesem allgemeinen Layout folgen.

Hinweis zur Unterstützung

Fügen Sie direkt nach dem Titel des Artikels den folgenden Hinweis ein.

Hinweis

Der folgende Artikel über den Connector wird von <Firmenname>, dem Eigentümer dieses Connectors und einem Mitglied des Microsoft Power Query Connector Certification Program, zur Verfügung gestellt. Wenn Sie Fragen zum Inhalt dieses Artikels haben oder Änderungen an diesem Artikel wünschen, besuchen Sie die Website <unter> und nutzen Sie die dortigen Supportkanäle.

Ersetzen Sie <Firmenname> durch Ihren Firmennamen.

Zusammenfassungstabelle

Erstellen Sie nach dem Unterstützungsvermerk eine zusammenfassende Tabelle mit den folgenden Informationen:

  • Freigabestatus: Zeigt an, ob der Connector in der Vorschau oder allgemein verfügbar ist. Verwenden Sie entweder „Vorschau“ oder „Allgemeine Verfügbarkeit“.
  • Unterstützte Produkte: Listet die Produkte auf, die Ihren benutzerdefinierten Connector verwenden können.
  • Unterstützte Authentifizierungsarten: Listet die Authentifizierungstypen auf, die Ihr benutzerdefinierter Connector unterstützt.
  • Funktionsreferenzdokumentation: Listet alle M-Formelsprachendokumentation auf, die mit Ihrem benutzerdefinierten Connector verbunden ist.

Tabelle mit der Zusammenfassung der Supportinformationen des Connectors.

Wenn Ihr benutzerdefinierter Connector auf verschiedenen Produkten implementiert ist, aber auf diesen Produkten unterschiedliche Funktionen hat, fügen Sie den folgenden oder einen ähnlichen Hinweis in Ihren Artikel nach der Übersichtstabelle ein.

Hinweis

Einige Funktionen können in einem Produkt vorhanden sein, in anderen jedoch nicht, was an den Bereitstellungsplänen und hostspezifischen Funktionen liegt.

Voraussetzungen

Wenn Ihr benutzerdefinierter Connector erfordert, dass andere Anwendungen auf dem System installiert werden, auf dem Ihr Connector läuft, oder dass ein Einrichtungsverfahren durchgeführt wird, bevor Sie Ihren benutzerdefinierten Connector verwenden, müssen Sie einen Abschnitt Voraussetzungen einfügen, der diese Installations- und Einrichtungsverfahren beschreibt. Dieser Abschnitt muss auch Informationen über die Einrichtung der verschiedenen Versionen Ihres Connectors enthalten (falls zutreffend).

Unterstützte Funktionen

Dieser Abschnitt sollte eine Liste der Funktionen enthalten, die von Ihrem benutzerdefinierten Connector unterstützt werden. Bei diesen Fähigkeiten handelt es sich in der Regel um eine Aufzählung, die angibt, ob der Connector die Modi „Import“ und „DirectQuery“ unterstützt, sowie um alle erweiterten Optionen, die im anfänglichen Dialogfeld verfügbar sind, das angezeigt wird, nachdem der Benutzer Ihren Connector unter Daten abrufenausgewählt hat.

Anweisungen zum Connector

Dieser Abschnitt enthält die für die Datenverbindung erforderlichen Verfahren. Wenn Ihr benutzerdefinierter Connector nur in Power Query Desktop verwendet wird, ist nur ein Verfahren erforderlich. Wenn Ihr benutzerdefinierter Connector jedoch sowohl in Power Query Desktop als auch in Power Query Online verwendet wird, müssen Sie für jede Instanz eine eigene Prozedur in separaten Abschnitten bereitstellen. Das heißt, wenn Ihr benutzerdefinierter Connector nur von Power Query Desktop verwendet wird, haben Sie eine Prozedur, die mit einer Überschrift zweiter Ordnung beginnt, und eine einzelne Schritt-für-Schritt-Prozedur. Wenn Ihr benutzerdefinierter Connector sowohl von Power Query Desktop als auch von Power Query Online verwendet wird, haben Sie zwei Verfahren. Jedes Verfahren beginnt mit einer Überschrift zweiter Ordnung und enthält unter jeder Überschrift eine eigene Schritt-für-Schritt-Anleitung. Beispiele für jede dieser Verfahrensarten finden Sie in den Artikeln Beispiele für Connector.

Das Verfahren besteht aus einer nummerierten Liste, die jeden Schritt enthält, der erforderlich ist, um die Informationen auszufüllen, die benötigt werden, um eine normale Verbindung (ohne vorherige Optionen) zu den Daten herzustellen.

Hinweis

Alle neuen zertifizierten Connectors müssen Power BI-Dataflows unterstützen und Abschnitte für die Verbindung mit Ihren Daten sowohl in Power Query Desktop als auch in Power Query Online enthalten.

Verbinden mit erweiterten Optionen (optional)

Wenn Ihr benutzerdefinierter Connector erweiterte Optionen enthält, die zur Verbindung mit den Daten verwendet werden können, müssen diese Informationen in einem separaten Abschnitt der Dokumentation behandelt werden. Jede der erweiterten Optionen sollte dokumentiert werden, und der Zweck jeder erweiterten Option sollte in diesem Abschnitt erläutert werden.

Problembehandlung (optional)

Wenn Ihnen häufige Fehler bekannt sind, die bei Ihrem benutzerdefinierten Connector auftreten können, können Sie einen Abschnitt zur Fehlerbehebung hinzufügen, in dem Sie beschreiben, wie Sie den Fehler entweder beheben oder umgehen können. Dieser Abschnitt kann auch Informationen über bekannte Einschränkungen Ihres Connectors oder den Abruf von Daten enthalten. Sie können auch alle bekannten Probleme bei der Verwendung Ihres Connectors zur Verbindung mit Daten angeben.

Zusätzliche Anweisungen (fakultativ)

Alle anderen Anweisungen oder Informationen über Ihren Stecker, die in den vorherigen Abschnitten nicht behandelt wurden, können in diesen Abschnitt aufgenommen werden.

Ort und Format des Artikels

Das Format des Dateinamens für Ihren Connectorartikel sollte nur Kleinbuchstaben enthalten, mit einem Bindestrich zwischen den Wörtern. Der Dateiname für den Azure Blob Storage Connector lautet beispielsweise azure-blob-storage.md. Wenn Ihr Verbindungsname Akronyme verwendet, zählt das gesamte Akronym als ein Wort. Der Dateiname für den Hive-LLAP-Connector lautet zum Beispiel hive-llap.md.

Ihr Artikel sollte auf GitHub im Ordner connectors in der Power Query-Dokumentation zur Verfügung gestellt werden: https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/connectors. Vergewissern Sie sich, dass Sie auch einen Link zu Ihrem Artikel in der Liste der Verbindungen hinzufügen, der auf das richtige Logo-Bild verweist, das in den Ordner /connectors/media/index hochgeladen wurde. Achten Sie schließlich darauf, dass Sie einen Link zu Ihrem Artikel in die Inhaltsverzeichnisdatei einfügen (toc.yml). Zertifizierte Connectors sind nur unter Power BI (Semantikmodelle) verfügbar.

Sehen Sie sich unseren contributor guide an, wie Sie zu unserem Repo beitragen können.

Der Artikel sollte als Markdown-Datei formatiert und eingereicht werden. Es sollte den Microsoft-Stil für die Beschreibung der Verfahren und das Layout der Benutzeroberfläche verwenden.

Die folgenden Artikel enthalten Anleitungen zur Formatierung Ihres Dokuments in Markdown und zum Microsoft-Stil, den Sie beim Verfassen Ihres Artikels befolgen müssen:

Beispiel für Verbinderartikel

Hier finden Sie einige Beispielartikel für Power Query Connector, die Sie als Ausgangspunkt verwenden können: