Teams ドキュメントに投稿する

  • [アーティクル]

Teams のドキュメントは、 Microsoft Learn テクニカル ドキュメント ライブラリの一部です。 コンテンツはドキュメントセットと呼ばれるグループに編成され、それぞれが 1 つのエンティティとして管理される関連ドキュメントのグループを表します。 同じドキュメントセット内のアーティクルには、 の後 learn.microsoft.comに同じ URL パス拡張子があります。 たとえば、 /learn.microsoft.com/microsoftteams/... は Teams ドキュメントセット ファイル パスの先頭です。 Teams の記事は Markdown 構文で記述され、GitHub でホストされています。

ワークスペースを設定する

  • VS Code 内にインストールします。
  1. サイド アクティビティ バーの [拡張機能] アイコン を選択するか 、View => Extensions コマンドまたは Ctrl + Shift + X キーを使用して、 Docs Authoring Pack を検索します。
  2. [インストール] を選択します。
  3. インストール後、[ インストール ] が [ 管理 ] 歯車ボタンに変更されます。

Microsoft Docs共同作成者ガイドを確認する

共同作成者ガイドでは、 Microsoft Learn プラットフォームで技術コンテンツを作成、公開、更新するための指示を提供します。

Microsoft のライティング、スタイル、およびコンテンツ ガイド

  • Microsoft ライティング スタイル ガイド: Microsoft ライティング スタイル ガイドは、テクニカル ライティングの包括的なリソースであり、Microsoft の音声とスタイルに対する最新のアプローチを反映しています。 簡単に参照するには、このオンライン ガイドをブラウザーの [お気に入り ] メニューに追加します。

  • 開発者コンテンツの作成: Teams 固有のコンテンツは、プログラミングの概念とプロセスの基本的な理解を持つ開発者対象ユーザーを対象としています。 Microsoft のトーンとスタイルを維持しながら、明確で技術的に正確な情報を説得力のある方法で提供することが重要です。

  • 詳細な手順を記述する: 適用された対話型エクスペリエンスは、開発者が Microsoft の製品とテクノロジについて学習するための優れた方法です。 複雑または単純な手順をプログレッシブ形式で表示することは自然で使いやすいです。

MarkDown リファレンス

Microsoft Learn ページは MarkDown 構文で記述され、 Markdig エンジンを介して解析されます。 特定のタグと書式設定規則の詳細については、「 Docs Markdown リファレンス」を参照してください。

ファイル パス

相対パスを使用して他のドキュメントセットへのリンクを作成する場合は、ドキュメント内のハイパーリンクの有効なファイル パスを設定することが重要です。 ビルドは、ファイル パスが正しいか有効な場合にのみ GitHub で成功します。

ハイパーリンクとファイル パスの詳細については、 ドキュメントのリンクの使用に関するページを参照してください。

重要

Teams プラットフォーム ドキュメントセット の一部 である記事を参照するには:
 ✔ スラッシュを付けずに相対パスを使用します。
 ✔ Markdown ファイル拡張子を含めます。
例: 親ディレクトリ/ディレクトリ/パスから article.md —>Microsoft Teams 用のアプリをビルドする

Teams プラットフォーム ドキュメントセットに 含まれていない Microsoft Learn の記事を参照するには:
 ✔ スラッシュで始まる相対パスを使用します。
 ✔ ファイル拡張子は含めないでください。
例: /docset/address-to-file-location —>Microsoft Graph APIを使用して Microsoft Teams を操作する

GitHub など、Microsoft Learn の外部のページを参照するには、完全な https ファイル パスを使用します。

コード サンプルとスニペット

コード サンプルは、API と SDK を効果的に使用するために重要な役割を果たします。 よく説明されたコード サンプルは、説明的なテキストや説明情報だけでは、物事がどのように機能するかを伝えることができます。 コード サンプルは、正確で簡潔で、十分に文書化され、読者にわかりやすいものでなければなりません。 読みやすいコードは、わかりやすく、テスト、デバッグ、保守、変更、拡張する必要があります。 詳細については、 記事にコードを含める方法に関するページを参照してください。

次の手順

Microsoft Teams アプリのトラブルシューティング

関連項目