Dostarczanie dokumentacji użytkownika dla łącznika niestandardowego
Po zakończeniu projektowania łącznika usługi Data Factory należy przesłać artykuł zawierający instrukcje dotyczące sposobu używania łącznika do publikacji w witrynie Microsoft Learn. W tym artykule omówiono układ takiego artykułu i sposób formatowania tekstu artykułu.
W tej sekcji opisano ogólny układ artykułów łącznika. Artykuł dotyczący łącznika powinien być zgodny z tym ogólnym układem.
Bezpośrednio po tytule artykułu wstaw następującą notatkę.
Uwaga
Poniższy artykuł łącznika jest dostarczany przez <nazwę> firmy, właściciela tego łącznika i członka programu certyfikacji łącznika Microsoft Power Query. Jeśli masz pytania dotyczące zawartości tego artykułu lub zmiany, które chcesz zobaczyć w tym artykule, odwiedź <witrynę internetową nazwy> firmy i skorzystaj z dostępnych tam kanałów pomocy technicznej.
Zastąp <nazwę> firmy nazwą firmy.
Po przypisaniu pomocy technicznej podaj tabelę podsumowania zawierającą następujące informacje:
- Stan wydania: wskazuje, czy łącznik jest w wersji zapoznawczej, czy ogólnie dostępny. Użyj opcji "Wersja zapoznawcza" lub "Ogólna dostępność".
- Obsługiwane produkty: wyświetla listę produktów, które mogą używać łącznika niestandardowego.
- Obsługiwane typy uwierzytelniania: wyświetla listę typów uwierzytelniania obsługiwanych przez łącznik niestandardowy.
- Dokumentacja referencyjna funkcji: zawiera listę dowolnej dokumentacji języka formuł M skojarzonej z łącznikiem niestandardowym.
Jeśli łącznik niestandardowy jest implementowany na różnych produktach, ale ma różne możliwości w tych produktach, dołącz następującą lub podobną uwagę w artykule po tabeli podsumowania.
Uwaga
Niektóre funkcje mogą być obecne w jednym produkcie, ale nie w innych ze względu na harmonogramy wdrażania i możliwości specyficzne dla hosta.
Jeśli łącznik niestandardowy wymaga zainstalowania innych aplikacji w systemie z uruchomionym łącznikiem lub wymaga wykonania procedury konfiguracji przed użyciem łącznika niestandardowego, należy dołączyć sekcję Wymagania wstępne opisujące te procedury instalacji i konfiguracji. Ta sekcja musi również zawierać informacje o konfigurowaniu różnych wersji łącznika (jeśli ma to zastosowanie).
Ta sekcja powinna zawierać listę możliwości obsługiwanych przez łącznik niestandardowy. Te możliwości są zwykle listą punktowaną wskazującą, czy łącznik obsługuje tryby Importuj i DirectQuery, a także wszelkie zaawansowane opcje dostępne w początkowym oknie dialogowym, które są wyświetlane po wybraniu łącznika w obszarze Pobieranie danych.
Ta sekcja zawiera procedury wymagane do nawiązania połączenia z danymi. Jeśli łącznik niestandardowy jest używany tylko w programie Power Query Desktop, wymagana jest tylko jedna procedura. Jeśli jednak łącznik niestandardowy jest używany zarówno w programie Power Query Desktop, jak i w usłudze Power Query Online, należy podać oddzielną procedurę w osobnych sekcjach dla każdego wystąpienia. Oznacza to, że jeśli łącznik niestandardowy jest używany tylko przez program Power Query Desktop, masz jedną procedurę rozpoczynającą się od drugiego nagłówka zamówienia i jednej procedury krok po kroku. Jeśli łącznik niestandardowy jest używany zarówno przez program Power Query Desktop, jak i usługę Power Query Online, masz dwie procedury. Każda procedura rozpoczyna się od drugiego nagłówka kolejności i zawiera oddzielną procedurę krok po kroku pod każdym nagłówkiem. Przykłady każdego z tych typów procedur można znaleźć w artykule Przykładowy łącznik.
Procedura składa się z listy numerowanej, która zawiera każdy krok wymagany do wypełnienia informacji potrzebnych do zapewnienia normalnego połączenia (nie wymaga opcji z wyprzedzeniem) do danych.
Uwaga
Wszystkie nowe certyfikowane łączniki są wymagane do obsługi przepływów danych usługi Power BI i muszą zawierać sekcje służące do nawiązywania połączenia z danymi zarówno w programie Power Query Desktop, jak i w usłudze Power Query Online.
Jeśli łącznik niestandardowy zawiera zaawansowane opcje, które mogą służyć do łączenia się z danymi, te informacje powinny być omówione w oddzielnej sekcji dokumentacji. Każda z opcji zaawansowanych powinna być udokumentowana i cel każdej zaawansowanej opcji wyjaśnionej w tej sekcji.
Jeśli znasz jakiekolwiek typowe błędy, które mogą wystąpić w łączniku niestandardowym, możesz dodać sekcję rozwiązywania problemów, aby opisać sposoby naprawy błędu lub obejść ten błąd. Ta sekcja może również zawierać informacje na temat wszelkich znanych ograniczeń łącznika lub pobierania danych. Możesz również uwzględnić wszelkie znane problemy związane z nawiązywaniem połączenia z danymi za pomocą łącznika.
Wszelkie inne instrukcje lub informacje o łączniku, które nie zostały omówione w poprzednich sekcjach, mogą przejść w tej sekcji.
Format nazwy pliku dla artykułu łącznika powinien zawierać tylko małe litery z łącznikiem między wyrazami. Na przykład nazwa pliku łącznika usługi Azure Blob Storage jest azure-blob-storage.md. Jeśli nazwa łącznika używa akronimów, cała akronim jest liczone jako jedno słowo. Na przykład nazwa pliku łącznika HIVe LLAP jest hive-llap.md.
Artykuł powinien zostać udostępniony w witrynie GitHub w folderze łączników w repozytorium dokumentacji dodatku Power Query: https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/connectors. Upewnij się, że dodasz również link do artykułu na liście łączników odwołujących się do poprawnego obrazu logo przekazanego /connectors/media/index do folderu. Na koniec upewnij się, że dodasz link do artykułu w pliku spisu treści (toc.yml). Certyfikowane łączniki są dostępne tylko w usłudze Power BI (modele semantyczne).
Zapoznaj się z naszym przewodnikiem współautora, jak możesz współtworzyć nasze repozytorium.
Artykuł powinien być sformatowany i przesłany jako plik markdown. Powinien on używać stylu firmy Microsoft do opisywania procedur i układu interfejsu użytkownika.
Poniższe artykuły zawierają instrukcje dotyczące formatowania dokumentu w języku Markdown oraz stylu firmy Microsoft, który należy wykonać podczas tworzenia artykułu:
Oto kilka przykładowych artykułów dotyczących łącznika Power Query, których można użyć jako punktu początkowego:
- Adobe Analytics (tylko program Power Query Desktop)
- Azure SQL Database (Power Query Desktop i Power Query Online)