關於Wiki、README和 Markdown

  • 發行項

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

若要支援您的小組或項目參與者，請使用 Markdown 將豐富的格式、數據表和影像新增至您的小組專案。 您可以在小組專案 Wiki 內使用 Markdown 格式、新增至儀錶板的內容、您的小組專案自述檔或其他存放庫自述檔。

Wiki

使用您的小組專案 wiki 以與其他小組成員共用資訊。 當您從頭開始佈建 Wiki 時，新的 Git 存放庫會儲存您的 Markdown 檔案、影像、附件和頁面順序。 此 Wiki 支援共同編輯其內容和結構。

將現有的 Git 存放庫發佈至 Wiki

許多小組會使用 Markdown 記錄其程式代碼，並連同程式代碼一起簽入這些檔案。 雖然 Git 支援這類文件的維護和檢閱以及標準提取要求，但這類檔案對內容的取用者提出了一些挑戰。

  • 讀者必須經常篩選許多檔案和資料夾，才能找到感興趣的內容。
  • 內容缺乏組織和結構。 沒有固有的頁面階層可支援讀取器。
  • 不支援內容版本控制。
  • 搜尋內容需要搜尋程序代碼，而不是針對搜尋內容優化的搜尋體驗。

透過將程式代碼發佈為Wiki功能，您可以將小組專案中定義的一或多個 Git 存放庫發佈至Wiki。 此功能提供一種方式來維護您的內容與程式代碼基底，並可讓您選擇性地將內容發佈及更新至Wiki。

您如何管理您為小組專案布建之Wiki內容，與從 Git 存放庫發佈的Wiki頁面之間有重大差異。 如需詳細資訊，請參閱 將 Git 存放庫發佈至 Wiki。

Markdown

Markdown 可讓您輕鬆地格式化文字並包含影像。 您也可以連結至項目頁面、自述檔、儀錶板和提取要求內的檔。 您可以使用 Markdown，在下列位置為您的小組提供指引：

如需支持的語法，請參閱 在 Azure DevOps 中使用 Markdown。

讀我檔案

您可以為每個存放庫或小組項目定義自述檔或多個檔案。 在 Markdown 中撰寫自述檔，而不是純文本。

使用 README 頁面，導向參與者以在專案中工作。 請考慮新增下列指引：

  • 項目焦點
  • 必要條件
  • 設定環境
  • 提示，用於在專案中完成工作
  • 特定檔案的用途或使用
  • 專案特定的詞彙和縮略字
  • 關於認可或上傳變更和新增分支的工作流程指引
  • 項目贊助者或聯繫人

以下是一些偉大的 README，使用這些格式，並對所有物件說話以參考和靈感：