Wiki、README、Markdown について

  • [アーティクル]

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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

Wiki

チーム プロジェクトの Wiki を使って、他のチーム メンバーと情報を共有します。 Wiki を最初からプロビジョニングすると、新しい Git リポジトリにマークダウン ファイル、画像、添付ファイル、ページのシーケンスが格納されます。 この Wiki では、そのコンテンツと構造の共同編集がサポートされています。

チーム プロジェクト Wiki では、次の機能がサポートされています。

Wiki をプロビジョニングまたは作成する

Wiki コンテンツを操作する

Note

Firefox Web ブラウザーから印刷機能を使用できない場合があります。

Wiki コンテンツの書式設定

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

多くのチームは、Markdown を使用してコードを文書化し、コードと共にこれらのファイルにチェックします。 Git では、このようなドキュメントのメインとレビューと標準のプル要求がサポートされていますが、このようなファイルはコンテンツのコンシューマーにいくつかの課題をもたらします。

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

発行コードを Wiki 機能として使用すると、チーム プロジェクトで定義されている 1 つ以上の Git リポジトリを Wiki に発行できます。 この機能を使用すると、コード ベースと共にコンテンツをメインし、コンテンツを Wiki に選択的に発行して更新することができます。

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

Markdown

Markdown を使用すると、テキストの書式設定や画像の追加が簡単になります。 また、プロジェクト ページ、README ファイル、ダッシュボード、プル要求内のドキュメントにリンクすることもできます。 Markdown を使用して、次の場所でチームにガイダンスを提供できます。

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

README

リポジトリまたはチーム プロジェクトごとに、README ファイルまたは複数のファイルを定義できます。 プレーン テキストではなく Markdown に README を記述します。

プロジェクトの共同作成者間で作業の目標を一致させるには、README ページを使います。 次のガイダンスを追加することを検討してください。

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

この形式を使用し、参照とインスピレーションのためにすべての対象ユーザーに話す優れた READM を次に示します。