次の方法で共有

Wiki、README、Markdown について

Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019

Markdown を使用してチーム プロジェクトに豊富な書式設定、テーブル、画像を追加することで、チームとプロジェクトの共同作成者をサポートできます。 Markdown 形式は、チーム プロジェクト Wiki ページ、ダッシュボードに追加するコンテンツ、チーム プロジェクトの README ファイル、またはその他のリポジトリ README ファイルを強化します。

プロジェクト Wiki を設定する

チーム プロジェクト Wiki を使用すると、プロジェクトに関する情報を他のチーム メンバーと共有できます。 Wiki をゼロから設定すると、新しい Git リポジトリに Markdown (.md) ファイル、画像、添付ファイル、ページのシーケンスが格納されます。 Wiki では、コンテンツと構造の共同編集がサポートされています。

次のリンクでは、チーム プロジェクト Wiki でサポートされている機能について説明します。

新しい Wiki を作成する

Wiki コンテンツを操作する

Wiki コンテンツの書式設定

Git リポジトリを Wiki に発行する

多くのチームは、コードと共にリポジトリにチェックインする Markdown ファイルを使用してコードを文書化します。 Git では標準の pull request プロセスを使用してコード ドキュメント ファイルのメンテナンスとレビューをサポートしていますが、これらのファイルはコンテンツのコンシューマーに課題を提示する可能性があります。

  • ユーザーは、多くのファイルやフォルダーを調べることで、関心のあるコンテンツを見つける必要があります。
  • コンテンツには組織と構造がありません。 閲覧者をサポートするための固有のページ階層はありません。
  • コンテンツのバージョン管理はサポートされていません。
  • コンテンツを検索するには、コンテンツの検索用に最適化された検索エクスペリエンスではなく、コードを検索する必要があります。

[コードを Wiki として発行] 機能を使用すると、チーム プロジェクトで定義されている 1 つ以上の Git リポジトリを Wiki に発行できます。 この機能は、コード ベースと同期的にコード ドキュメントを維持する方法を提供し、ドキュメントを Wiki に選択的に発行して更新することができます。

チーム プロジェクトの Wiki のコンテンツを管理する方法と、Git リポジトリから発行する Wiki ページの間には大きな違いがあります。 詳細については、「 Git リポジトリを wiki に公開するを参照してください。

Markdown を使用してプロジェクトコンテンツを強化する

Markdown 形式を使用すると、テキストを簡単に書式設定し、画像を含めることができます。 また、プロジェクト ページ、README ファイル、ダッシュボード、プル要求内のドキュメントにリンクすることもできます。

Markdown を使用すると、次の方法でチームにガイダンスを提供できます。

サポートされている構文については、「 Azure DevOps での Markdown の使用」を参照してください。

プロジェクト README ファイルを追加する

リポジトリまたはチーム プロジェクトごとに、README ファイルまたは複数のファイルを定義できます。 プレーン テキストではなく Markdown に README を記述します。 README ページを使用して、プロジェクト内の特定の情報または場所に共同作成者を配置します。

次のガイダンスを追加することを検討してください。

  • プロジェクトフォーカス
  • 前提条件
  • 環境をセットアップする
  • プロジェクト内で作業を行う際のヒント
  • 特定のファイルの目的または使用
  • プロジェクト固有の用語と頭字語
  • 変更のコミットまたはアップロードとブランチの追加に関するワークフロー ガイダンス
  • プロジェクトのスポンサーまたは連絡先

README の例

参照とインスピレーションのためにすべての対象ユーザーをサポートする GitHub のプロジェクト READM の例を次に示します。