.NET Core 文件簡介

這篇貼文的作者是 Cloud + Enterprise Division 經理 Jeff Sandquist

今天,我們發行了docs.microsoft.com 的 .NET 檔預覽版。 若要深入瞭解新的檔體驗改善 docs.microsoft.com 供應專案,請流覽 docs.microsoft.com 部落格文章簡介。 除了在 docs.microsoft.com 平臺上提供所有共同作業功能、開放原始碼內容和更方便的 URL 之外,我們也引進了一些 .NET 開發人員特有的新功能。 本文將醒目提示這些新功能,並摘要說明未來計畫。

.NET 檔體驗的重點

為了伴隨 .NET Core 的令人興奮的 RTM 版本,我們將它放在 .NET 檔首頁的前面和中央。 為了補充 .NET Core RTM 版本,其中包含您需要快速開始使用的所有專案,我們已將文章連結和新的參考體驗放在清單頂端。

.NET Docs 首頁

手指提示的 .NET 生態系統

您會看到連結可下載新的 .NET Core 程式庫、ASP.NET、Entity Framework、Azure、使用 Xamarin 使用 .NET 建置 iOS 應用程式,以及使用 .NET 建置 通用 Windows 平臺 (UWP) 應用程式。 我們尚未將所有 .NET 內容移至 docs.microsoft.com,但 .NET 檔首頁將會是您所有 .NET 檔的起點。

.NET 檔區段的連結

文章

我們的作者和工程師以及一些專用社群成員一直努力建立新的 .NET Core 相關文章,您可以在 .NET 檔 一節中找到。 您可以在這裡找到一系列的文章,例如:

這些和其他許多主題全都會顯示在 docs.microsoft.com 主題中,每個頁面上都有一份全新的目錄,以及讀取每個文章的每個文章和參與者資訊的估計時間。

文章和指引

所有 .NET 文章都是開放原始碼,可在.NET 小組的檔存放庫中的GitHub上取得。 如果您在檔中發現任何問題或想要加以改善,那麼只要按一下每個文章右導覽中的 編輯 按鈕即可。

按一下 [編輯] 按鈕以檢視/編輯 GitHub 中的頁面

編輯文章就像按一下存放庫中任何 Markdown 檔案上的編輯按鈕一樣簡單、新增內容,以及提交提取要求。 一旦我們的小組檢閱並接受您的提取要求,您的貢獻會在幾分鐘內上線。

然後,您可以直接在 GitHub 中編輯內容。

API 參考

除了作者、工程師和熱心社群成員所撰寫的絕佳內容之外,我們也已大幅改善參考體驗。 此預覽版本中已完全重新設計參考體驗,並借用我們在 docs.microsoft.com 文章中使用的相同設計原則。

參考命名空間檢視

如同這些文章,新的參考頁面具有回應性、使用新式 Web 原則設計,而且在行動裝置上看起來會更好。

參考中的回應式設計

我們已將 類型搜尋 新增至所有 命名空間頁面。 這可讓您輕鬆地依類型名稱搜尋所有 .NET 類型。 使用每個按鍵時,我們會篩選左側導覽中顯示的類型清單。 這個令人興奮的參考區域新功能包含在我們的新架構中,以產生稱為 DocFX的 .NET 參考檔,這是 GitHub 上的開放原始碼專案) 。

參考命名空間檢視

當您在任何命名空間的左側導覽中按一下個別類型時,您會直接跳至該類型的命名空間頁面簡介區段。 按一下參考內容之主要區域中的類型名稱,您會看到類別的詳細資料頁面,其中包含類別的繼承鏈結、宣告和類別屬性和方法成員的詳細資料。

類別檢視

針對每個方法成員,您會看到參數的詳細資料,以及方法的摘要。

方法檢視

資訊與工程原則

除了持續開發和改善 DocFX 檔產生工具之外,我們也對新的 .NET 檔體驗中看到的工程和檔原則進行了重大改善。

更好的自動化

從潛在參與者收到提取要求時,我們會驗證參與者已遵循簽署參與者授權合約的簡單程式, (此程式是完全電子的,而且需要幾分鐘的時間才能完成) 。 只要貢獻遵守 貢獻指導方針,在接受提取要求之後,網站分鐘數應該會出現小型變更。

更好的 URL

整體 docs.microsoft.com 體驗的其中一個重要準則是改善搜尋索引編制和「猜測」的 URL。我們已在 .NET 檔中維護此原則。 文章和參考檔都有更清楚的 URL。 例如,系統命名空間的傳統 MSDN URL:

MSDN 上的系統命名空間 URL

在新的參考檔中,URL 更邏輯、人類可閱讀,最重要的是 更容易探索

docs.microsoft.com 上的系統命名空間 URL

更敏捷且開放式撰寫

內容不只開放原始碼,我們不僅接受社群貢獻。 此外,docs.microsoft.com (上的所有內容,包括 .NET 檔) 皆可在 Creative Commons 授權下取得。 您可以讀取、複製、參考、重複使用部分, (甚至是商業用途) 。 作者和工程師已在新系統中主動與社群成員合作。 這是一個有趣且令人興奮的轉換,我們未來有更多功能。

未來方案

這一節 docs.microsoft.com,如同網站的其餘部分仍在預覽狀態,因此我們鼓勵有意見反應和意見反應。 請將 您的功能想法 提交至 UserVoice。

在接下來的幾周中,我們將發佈 XML 批註,以直接在 .NET 原始程式碼中產生參考檔。 這可讓任何人輕鬆按一下更新.NET Framework參考檔。
我們也會繼續調整參考的設計和版面配置,以及上述編輯參考內容本身的能力。

我們很高興將新的 .NET 檔區域帶到 docs.microsoft.com,我們期望未來能讓您的體驗變得更好!