Dela via


Tillhandahålla användardokumentation för din anpassade anslutningsapp

När du har skapat datafabriksanslutningsappen måste du skicka in en artikel som innehåller instruktioner om hur du använder anslutningsappen för publicering på Microsoft Learn. I den här artikeln beskrivs layouten för en sådan artikel och hur du formaterar texten i din artikel.

Artikellayout

I det här avsnittet beskrivs den allmänna layouten för anslutningsartiklarna. Artikeln om anslutningsappen bör följa den här allmänna layouten.

Supportanteckning

Infoga följande anteckning direkt efter rubriken på artikeln.

Kommentar

Följande anslutningsappsartikel tillhandahålls av <företagets namn>, ägaren av den här anslutningsappen och en medlem i Certifieringsprogrammet för Microsoft Power Query Connector. Om du har frågor om innehållet i den här artikeln eller har ändringar som du vill se gjorda i den här artikeln kan du besöka <webbplatsen för företagsnamn> och använda supportkanalerna där.

Ersätt <företagets namn> med ditt företagsnamn.

Sammanfattningstabell

Efter supportanteckningen anger du en sammanfattningstabell som innehåller följande information:

  • Versionstillstånd: Anger om anslutningsappen är i förhandsversion eller allmän tillgänglighet. Använd antingen "Förhandsversion" eller "Allmän tillgänglighet".
  • Produkter som stöds: Visar en lista över de produkter som kan använda din anpassade anslutningsapp.
  • Autentiseringstyper som stöds: Visar en lista över de autentiseringstyper som din anpassade anslutningsapp stöder.
  • Dokumentation om funktionsreferens: Visar en lista med dokumentation om M-formelspråk som är associerad med din anpassade anslutningsapp.

Tabell som innehåller sammanfattningen av anslutningsprogrammets supportinformation.

Om din anpassade anslutningsapp implementeras på olika produkter, men har olika funktioner för dessa produkter, inkluderar du följande eller liknande anteckning i artikeln efter sammanfattningstabellen.

Kommentar

Vissa funktioner kan finnas i en produkt, men inte andra på grund av distributionsscheman och värdspecifika funktioner.

Förutsättningar

Om din anpassade anslutningsapp kräver att andra program installeras på systemet som kör anslutningsappen eller kräver att en konfigurationsprocedur utförs innan du använder din anpassade anslutningsapp, måste du inkludera ett kravavsnitt som beskriver de här installations- och konfigurationsprocedurerna. Det här avsnittet måste också innehålla information om hur du konfigurerar olika versioner av anslutningsappen (om tillämpligt).

Funktioner som stöds

Det här avsnittet bör innehålla en lista över de funktioner som stöds av din anpassade anslutningsapp. De här funktionerna är vanligtvis en punktlista som anger om anslutningsappen stöder import- och DirectQuery-lägen, och även eventuella avancerade alternativ som är tillgängliga i den inledande dialogrutan som visas när användaren har valt anslutningsappen i Hämta data.

Anslutningsinstruktioner

Det här avsnittet innehåller de procedurer som krävs för att ansluta till data. Om din anpassade anslutningsapp endast används i Power Query Desktop krävs bara en procedur. Men om din anpassade anslutningsapp används på både Power Query Desktop och Power Query Online måste du ange en separat procedur i separata avsnitt för varje instans. Om din anpassade anslutningsapp endast används av Power Query Desktop har du en procedur som börjar med en andra orderrubrik och en enda steg-för-steg-procedur. Om din anpassade anslutningsapp används av både Power Query Desktop och Power Query Online har du två procedurer. Varje procedur börjar med en andra orderrubrik och innehåller en separat stegvis procedur under varje rubrik. Exempel på var och en av dessa typer av procedurer finns i Exempelkopplingsartiklar.

Proceduren består av en numrerad lista som innehåller varje steg som krävs för att fylla i den information som behövs för att tillhandahålla en normal anslutning (kräver inte förhandsalternativ) till data.

Kommentar

Alla nya certifierade anslutningsappar krävs för att stödja Power BI-dataflöden och måste innehålla avsnitt för att ansluta till dina data i både Power Query Desktop och Power Query Online.

Ansluta med avancerade alternativ (valfritt)

Om din anpassade anslutningsapp innehåller avancerade alternativ som kan användas för att ansluta till data bör den här informationen tas upp i ett separat avsnitt i dokumentationen. Vart och ett av de avancerade alternativen ska dokumenteras och syftet med varje avancerat alternativ som beskrivs i det här avsnittet.

Felsökning (valfritt)

Om du känner till några vanliga fel som kan uppstå med din anpassade anslutningsapp kan du lägga till ett felsökningsavsnitt för att beskriva olika sätt att antingen åtgärda felet eller kringgå felet. Det här avsnittet kan också innehålla information om kända begränsningar i din anslutningsapp eller hämtning av data. Du kan också ta med kända problem med att använda anslutningsappen för att ansluta till data.

Ytterligare instruktioner (valfritt)

Andra instruktioner eller information om din anslutningsapp som inte omfattas av föregående avsnitt kan gå i det här avsnittet.

Artikelplats och format

Filnamnsformatet för anslutningsappsartikeln får endast innehålla gemener med bindestreck mellan ord. Filnamnet för Azure Blob Storage-anslutningsappen är till exempel azure-blob-storage.md. Om anslutningsappens namn använder förkortningar räknas hela förkortningen som ett ord. Filnamnet för Hive LLAP-anslutningsappen är till exempel hive-llap.md.

Artikeln bör göras tillgänglig på GitHub under mappen connectors i Power Query-dokumentationsdatabasen: https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/connectors. Se till att du även lägger till en länk till din artikel i listan över anslutningsappar som refererar till rätt logotypbild som laddats upp till /connectors/media/index mappen. Slutligen kontrollerar du att du lägger till en länk till artikeln i innehållsförteckningsfilen (toc.yml). Certifierade anslutningsappar är endast tillgängliga under Power BI (semantiska modeller).

Se vår deltagarguide om hur du kan bidra till vår lagringsplats.

Artikeln ska formateras och skickas som en Markdown-fil. Den bör använda Microsoft-formatmallen för att beskriva procedurer och användargränssnittslayouten.

Följande artiklar innehåller anvisningar om hur du formaterar dokumentet i Markdown och det Microsoft-format som du bör följa när du redigerar artikeln:

Exempel på anslutningsartiklar

Här är ett par exempel på power query-anslutningsartiklar som du kan använda som utgångspunkt: