Azure DevOps プロジェクト Wiki の概要
Azure DevOps Projects には、プロジェクト Wiki を作成するためのオプションが含まれています。
チームと情報を共有し、プロジェクトを理解して、プロジェクトに貢献するための Wiki。
Wiki はリポジトリに格納されます。 Wiki は自動的にプロビジョニングされません。
前提条件
コードを Wiki として公開するにはリポジトリを作成するためのアクセス許可が必要です。 プロジェクト管理者グループには、既定でこのアクセス許可が付与されていますが、他のユーザーに割り当てることもできます。
Wiki ページを追加または編集するには、共同作成者グループのメンバーである必要があります。
チーム プロジェクトのすべてのメンバー (利害関係者を含む) は、Wiki を見ることができます。
作成
Wiki の作成の詳細については、「プロジェクトの Wiki を作成する」をご覧ください。
Wiki の編集
Wiki に Git リポジトリを公開する方法の詳細については、「Git リポジトリを Wiki に公開する」で詳しく説明しています。
Markdown
Azure DevOps Wiki は Markdown で記述されており、添付ファイルやビデオを含めることもできます。
Markdown はマークアップ言語です。 プレーンテキストには、書式設定の構文が含まれています。 これは、プロジェクトとソフトウェアのドキュメントの記述に関する事実上の標準になっています。
この主な理由の 1 つは、プレーンテキストで構成されているため、プログラム コードをマージするときと同じ方法でより簡単にマージできることです。
これにより、プロジェクト内の他のコードの作成に使用したのと同じツールを使用してドキュメントを管理できます。
GitHub Flavored Markdown (GFM)
GFM は、CommonMark という基本形式に拡張機能が追加された、GitHub によってリリースされた正式な仕様です。 GFM は、GitHub 内および外部の両方で広く使用されています。 GFM は、Azure DevOps Wiki でレンダリングされます。
Mermaid
Mermaid は、図をドキュメントに含めることができるため、Markdown の重要な拡張機能になりました。
これにより、バイナリ ファイルとして表わされた図を含むドキュメントをマージする際の難しさが解消されました。
Mermaid 構文の詳細については、Mermaid の概要に関するページをご覧ください。