docs.microsoft.com 的 11 月更新

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

今天,我們很高興宣佈,我們現在已將 Azure、Visual Studio 2017 RC、C++、ASP.NET Core、Entity Framework Core 和 Linux 上的 SQL 檔移轉至docs.microsoft.com

將所有內容集結在同一處,可以讓客戶在行動支援、當地語系化、留言、社交分享或社群投稿上使用同樣的功能。

這次雖然是主要版本發行,我們仍會持續定期更新內容與網站功能。因此,請務必透過 UserVoice 傳送意見反應給我們,表達您對相關內容的看法。

我們將會在未來幾個月中陸續新增 Dynamics 365、Windows Server、SQL Server、System Center 與 Windows Desktop 的內容。

本貼文主題

  • Docs 的主要功能
  • Docs 的新功能
  • Azure 文件
  • Visual Studio 2017 RC 文件
  • C++ 文件
  • ASP.NET Core 文件
  • Entity Framework Core 文件
  • SQL on Linux 文件

Docs 的主要功能

若您還不熟悉 docs.microsoft.com,以下是此新服務的一些主要功能介紹。

預估閱讀時間與上次更新日期

我們根據您的輸入所做的簡單增強功能,可提供文章的估計閱讀時間。 我們知道許多您在會議之間的幾分鐘內學習和評估技術,而且如果您知道需要多少時間承諾,則更可能閱讀文章。

我們也為內容新增了時間戳記,協助客戶了解內容的新舊程度,猜測文章上次更新的時間已成為過去式。

螢幕擷取畫面1

自適應設計

為能讓使用者在行動裝置、平板電腦及電腦上獲得良好的經驗,我們實作了自適應配置。 在小螢幕裝置上按一下頁面頂端的 [選項] 按鈕,可以讓您存取您在桌上型電腦瀏覽器中一樣的選項。

螢幕擷取畫面 2

全球化文件

我們不只一次聽到國際間的客戶反映當地語系化內容的重要性。 docs.microsoft.com 現在支援 45 國語言,其中也包括由右至左的語種,像是阿拉伯文及希伯來文;對於因為使用後援邏輯而無法提供當地語系化文件的 Dynamics 365,也提供 63 種地區設定。 這使得我們的文件達到真正的全球化,而且可以讓我們在未來新的一年中隨時新增內容。

螢幕擷取畫面3螢幕擷取畫面4

旁注及留言

您的問題、留言與意見對我們很重要。 我們已與 Livefyre 合作,提供所有文章的批註和側注。 在每個文章頂端,您會看到直接跳至批註一節的選項。

我們希望聽取您的意見,而且會密切注意 Docs 上的所有留言及問題,並加以回覆。

螢幕擷取畫面 5

您可以使用您現有的 Twitter、Facebook、Google、Yahoo 或 Microsoft 認證登入留言。

螢幕擷取畫面6

此外,您也能追蹤您想要關注的討論串,在我們的團隊或社群成員回覆您意見時,掌握到最新的狀況。

螢幕擷取畫面7

您也可以在每個內容段落新增旁注,或將文字明確地反白出來。 若要執行此動作,只要使用滑鼠游標選取文字區塊,或按一下您將滑鼠停留在段落的右側時所出現留言圖示。

螢幕擷取畫面 8

分享社交圈

位於頁面頂端的 [共用] 按鈕可讓您隨時將我們的內容分享給您的 Twitter 粉絲及 Facebook 朋友。

螢幕擷取畫面 9

您也可以使用滑鼠直接選取內容,透過關聯式小工具進行分享。

螢幕擷取畫面 10

淺色/深色佈景主題

我們也新增了主題選擇器,讓您可以在淺色和深色主題之間變更,也就是您擁有 [asked for on UserVoice](https://msdocs.uservoice.com/forums/364242-general-site-feedback/suggestions/14999211-komplete-dark-theme) 的部分。

螢幕擷取畫面 12

使用者易記的 URL

我們關心我們的 Web 體驗,但有件事一直讓身為 TechNet 與 MSDN 使用者困擾的就是文章的 URL 實在不好記而且不易於閱讀。 以下是使用新 URL 的相同文章範例。

之前

https://technet.microsoft.com/library/dn646983.aspx3

After

https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune

社群貢獻

網站上大部分的文件都提供社群投稿功能。 只要按一下右上方功能表中的 [編輯] 按鈕,就能前往對應的 GitHub 頁面、複製存放庫、執行變更及提交您的提取要求。 歡迎您編輯當地語系化的內容,並對整體的投稿經驗提供您的寶貴意見。

螢幕擷取畫面 13

Docs 的新功能

有許多功能是自 5 月份發行以來就已經存在的功能,我們也額外新增了下列許多新功能。

即時目錄篩選

目錄現在隨時都能進行篩選。 這表示您只要隨意輸入幾個字元,就能篩選任何相符的文字,從而找出您所需要的內容。

螢幕擷取畫面 14

左導覽目錄

我們新增了這項重要功能來解決問題內容分處多個網站的問題。 有關於如何將 ASP.NET 應用程式部署到 Azure App Service 的文章應列在 Azure 或 ASP.NET 之下? 兩者皆是,但基於探索與一致兩項原因,不會將內容複製到兩個網站的區段中。

為了達成此目的,我們讓內容小組從 Docs 上選取任意內容,然後為客戶建立該內容的檢視。 下圖是可能會對使用 Docker 之 .NET 開發人員顯示的版面配置示意圖,其中可能包括 Azure、ASP.NET、.NET Core 及 Visual Studio Azure SDK 小組隨附的內容,全部盡在同一個檢視之中。

螢幕擷取畫面 15

可驗證的程式碼範例

最令人氣餒的文件功能之一,就是所提供或連結的範例在您的電腦上根本無法運作。 Microsoft 有數以千計的程式碼範例及程式碼片段,我們希望我們的客戶相信這些範例能夠在支援的平台與組態上運作。

為達成此目的,我們開發出可延伸的持續整合 (CI) 系統,確保這些範例在指定的一組作業系統與工具鏈上,能夠編譯及產生預期的輸出。 我們仍持續努力讓更多小組也能採取此作法,藉此確保下載程式碼的使用者能夠有信心,相信這些程式碼可以通過必要的品質檢查。

整合式參考內容

我們已重新設計基礎 DocFX 引擎 (即支援 docs.microsoft.com 的開放原始碼元件),加入不同平台及格式的語言繫結。 這包括下列項目的支援:

  • Azure CLI (Python)
  • PowerShell
  • .NET 與 .NET Core
  • Java
  • Swagger / REST API

因為現在只會有一個實際的來源,再從其產生文件及程式碼,所以這對客戶而言,文件與 API 功能不再會愈來愈不一致。 您可以從 Azure 及 ASP.NET/EF 的下列各節中,閱讀更多有關於特定 API 支援的參考。

PDF 支援

另外一項客戶一直要求的重要功能是 PDF 支援。無論使用桌上型電腦或行動裝置,您都能下載一組特定的文件帶著走,但卻不會佔用掉您好幾 GB 的空間。

為達成此目的,我們為目錄功能啟用了 PDF 支援。 我們已經確認當上線網站上的內容有所更新時,其 PDF 檔案也會隨之更新,讓您隨時都能閱讀最新最棒的內容。

<img alt=「screenshot16] ()

Azure 文件

我們聽過您對體驗片段和挑戰的意見反應,因此我們很熟悉從 azure.microsoft.comMSDNGitHub 移轉 Azure 技術檔,並將其合併在 上 https://docs.microsoft.com/azure/

新的 Azure 中樞頁面

我們也藉此機會變更了 Azure 內容登陸頁面的外觀與風格。 以下是一些重點摘要︰

  • [服務] 索引標籤會依類別分組列出 Azure 服務。
  • [開發人員] 索引標籤會列出 REST APIAzure.NET SDKAzure Java SDKAzure CLIPowerShell 的所有 Azure 參考內容。
  • [架構] 索引標籤適用於結構設計師及開發人員,可了解雲端規模的設計模式。
螢幕擷取畫面 17

新的服務頁面

我們已經確定登陸頁面一致,而且會連結到下列重要資源︰

  • [服務概觀] 連結。
  • 快速入門教學課程適用於所有相關平台及程式設計語言。
  • 指定服務之所有教學課程影片的連結。
  • API 參考內容的連結。
  • 下載該服務所有文件的連結。
螢幕擷取畫面 18

新的目錄

我們利用移轉到 docs.microsoft.com/azure 的機會,改進了目錄導覽的一致性。 每項服務雖各有其獨特的特性,但現在當您在此網站中移動時,都會顯示類似的導覽。

改進色彩標示

對於代表 Azure 命令列介面 (CLI) 的程式碼範例,我們為關鍵字及參數新增了色彩標示,方便您閱讀及了解我們的程式碼。

螢幕擷取畫面 19

參考的改進項目

客戶反映的最大痛點之一,是我們的 API、命令列及 PowerShell 內容從來都不會是最新版本。 隨著 Azure 的變更速度愈來愈快,舊有的工作流程已無法因應。

在此版本中,我們改變了我們的系統,使其直接從原程程式碼建立參考。 當新的組建交付時,新的內容也會一併交付。 一如您投稿到我們的如何內容般,您也能對文件自動產生的部分投稿。

我們也會標準化使用 Open API 規格 (前身為 Swagger) 描述 REST API 的用法。這可以讓我們為 REST 服務提供統一的資料表示法,並可在文件及用戶端 SDK 中使用。 未來我們也能夠為我們的 REST 文件及範例要求/回應承載新增互動式功能。

我們為此版本啟用了下列功能:

螢幕擷取畫面20螢幕擷取畫面21

Visual Studio 2017 RC 文件

我們會將所有 Visual Studio 文件直接整合到新的及更新的 docs.microsoft.com 經驗。

新的 Visual Studio 中樞頁面

Visual Studio 中樞頁面包含如何開始使用 Visual Studio 2017 候選版的重要連結。

其中包括了安裝指南新功能快速入門教學課程。 近期內也將推出當地語系化的內容。 一些主題也將加入新的內容,例如重構;使用不在專案中的程式碼;對效能問題執行偵錯;最佳化 Visual Studio 啟動時間的提示;編輯器中所有新生產力與程式導覽功能的詳細資料等等。

Visual Studio 現在也可讓您自訂整套的安裝程序,讓您可以只安裝您想要使用的元件。無論您的工作負載是否與 ASP.NET、Azure、Python 或 Windows 平台相關,您都能深入了解其對於個別開發專案的運作方式。

ASP.NET 與 Entity Framework Core 文件

ASP.NET Core 與 Entity Framework Core 文件也分別從 docs.asp.net 及 GitHub 移轉而出。

ASP.NET / Entity Framework 參考

由於 ASP.NET CoreEntity Framework Core 屬於開放原始碼專案,我們巧妙地整合了這兩項服務的原始程式碼及三斜線註解,從而建置了各自的 API 參考文件。 這意味著 API 與文件永遠會自動保持同步。

C++ 文件

為回應客戶長期以來的要求,我們重構了 C++ 參考精簡其格式,以減少主題之間的連結。 您現在可以從同一個類別主題中,尋找其他類別成員的所有文件。

此外,您如需深入了解最新的 C++ 標準規範變更及新的建置選項 (例如 /fastlink),可使用新的移轉指導升級您舊版 Visual Studio 的程式碼,然後探索如何使用 gcc 在 Linux 系統上執建置的新支援。

SQL on Linux 文件

SQL Server on Linux (SQL Server vNext Customer Technical Preview 1 的一部分) 現在正等著您來試用! 此中樞頁面包含一些重要連結,可以讓您從快速入門連結到如何使用 SQL Server on Linux 進行管理及開發。 近期內將推出當地語系化的內容。

結論

我們迫不及待想要為新文件網站發行更多的功能,確保其運作與我們的產品及服務相符。 由於您是使用者,是檔程式中最重要的部分,建議您與我們連絡,並提供意見反應,說明如何在 Twitter上為您提供更好的體驗。