カスタム コネクタのユーザー ドキュメントの用意
Power Query カスタム コネクタの設計が完了したら、docs.microsoft.com で公開するために、コネクタの使用方法を説明した記事を送信する必要があります。 この記事では、そのような記事のレイアウトと、記事のテキストの書式を設定する方法について説明します。
記事のレイアウト
このセクションでは、Power Query コネクタに関する記事の一般的なレイアウトについて説明します。 カスタム コネクタの記事は、この一般的なレイアウトに従うようにしてください。
サポートに関する注記
記事のタイトルのすぐ後に、次のような注記を挿入します。
注意
コネクタに関する次の記事は、このコネクタの所有者であり、Microsoft Power Query コネクタ認定プログラムのメンバーである <company name> によって提供されています。 この記事の内容についてご質問がある場合や、この記事に加えたい変更がある場合は、<company name> の Web サイトにアクセスし、そこでサポート チャネルをご利用ください。
<company name> は会社名に置き換えます。
概要テーブル
サポートの注記の後に、次の情報を含む概要の表を記載します。
- リリース状態: そのコネクタがプレビュー段階か一般提供段階かを示します。 "プレビュー" または "一般提供" のいずれかを使います。
- サポートされている製品: カスタム コネクタを使用できる製品を列挙します。
- サポートされている認証の種類: カスタム コネクタでサポートされている認証の種類を列挙します。
- 関数のリファレンス ドキュメント: カスタム コネクタに関連付けられている M 数式言語ドキュメントをすべて列挙します。

カスタム コネクタがさまざまな製品に実装されていて、製品ごとに機能が異なる場合は、概要の表の後に、次のような注記を記事に含めます。
注意
デプロイ スケジュールにより、またホスト固有の機能があることにより、ある製品に存在する機能が他の製品にはない場合があります。
前提条件
カスタム コネクタを使うには、そのコネクタを実行しているシステムに他のアプリケーションをインストールする必要がある場合、またはカスタム コネクタを使う前に設定手順を完了する必要がある場合は、それらのインストールおよび設定手順を説明する「前提条件」セクションを含める必要があります。 このセクションには、さまざまなバージョンのコネクタの設定に関する情報も含まれます (該当する場合)。
サポートされる機能
このセクションには、カスタム コネクタがサポートする機能の一覧を記載します。 通常、これらの機能は、コネクタがインポート モードと DirectQuery モードをサポートしているかどうかを示す箇条書きの一覧です。また、ユーザーが [データの取得] でコネクタを選んだ後に表示される最初のダイアログ ボックスで使用できる、すべての詳細オプションも含まれます。
接続手順
このセクションには、データに接続するために必要な手順を記載します。 カスタム コネクタが Power Query Desktop でのみ使われる場合、必要な手順は 1 つだけです。 ただし、カスタム コネクタを Power Query Desktop と Power Query Online の両方で使う場合は、インスタンスごとに別のセクションに別の手順を記載する必要があります。 つまり、カスタム コネクタが Power Query Desktop のみで使われる場合は、第 2 レベルの見出しと 1 つのステップバイステップの手順で始まる 1 つの手順を記載することになります。 カスタム コネクタが Power Query Desktop と Power Query Online の両方で使われる場合は、2 つの手順を記載します。 各手順は、第 2 レベルの見出しで始まり、それぞれの見出しの下に独立したステップバイステップの手順を記載します。 各種類の手順の例については、「コネクタの記事の例」を参照してください。
手順は、(詳細オプションを必要としない) データへの通常の接続に必要な情報を入力する各手順を記載した番号付きリストで構成されています。
詳細オプションを使用して接続する (省略可能)
データへの接続に使用できる詳細オプションがカスタム コネクタにある場合は、その情報をドキュメントの別のセクションで説明する必要があります。 各詳細オプションを文書化し、各詳細オプションの目的をこのセクションで説明する必要があります。
トラブルシューティング (省略可能)
カスタム コネクタで発生する可能性のある一般的なエラーがわかっている場合は、トラブルシューティング セクションを追加して、エラーを修正したり、エラーを回避したりする方法を説明することができます。 このセクションには、コネクタの既知の制限やデータの取得に関する情報を記載することができます。 また、コネクタを使ってデータに接続する際の既知の問題も記載することができます。
その他の手順 (省略可能)
前のセクションで取り上げられていない、コネクタに関するその他の指示または情報は、このセクションに記載できます。
記事の場所と形式
記事は、GitHub の Power Query ドキュメント リポジトリ内の Connectors フォルダー (https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/Connectors) 以下で参照できるようにします。 また、/Connectors/media/index フォルダーにアップロードした正しいロゴ画像を参照して、コネクタ一覧に記事へのリンクも追加してください。 最後に、目次ファイル (TOC.yml) に記事へのリンクを追加します。 Power BI (データセット) には、認定コネクタのみが表示されます。
リポジトリに投稿する方法については、Microsoft Docs 共同作成者ガイドのページを参照してください。
記事は Markdown ファイルとして書式を設定し、送信する必要があります。 手順と UI のレイアウトを記述する際には、Microsoft スタイルを使う必要があります。
次の記事には、Markdown でのドキュメントの形式に関する指示と、記事を作成するときに従う必要がある Microsoft スタイルが記載されています。
コネクタの記事の例
出発点として使用できる Power Query コネクタの記事の例をいくつか紹介します。
- Adobe Analytics (Power Query Desktop のみ)
- Azure SQL データベース (Power Query Desktop と Power Query Online)