docs.microsoft.com의 11월 업데이트

  • 아티클

이 게시물은 클라우드 + 엔터프라이즈 사업부의 총괄 관리자인 Jeff Sandquist에 의해 작성되었습니다.

오늘 Azure, Visual Studio 2017 RC, C++, ASP.NET Core, Entity Framework Core 및 SQL on Linux 관련 설명서를 docs.microsoft.com으로 마이그레이션했다는 소식을 알려드리게 되어 대단히 기쁘게 생각합니다!

모든 콘텐츠를 하나로 모음으로써 모바일 지원, 지역화, 의견, 소셜 공유 또는 커뮤니티 기여에 대해 고객 환경의 일관성이 유지될 것입니다.

이 소식도 중요하지만, 저희가 콘텐츠와 사이트 기능을 정기적으로 계속 업데이트해 나갈 예정이므로 콘텐츠 환경에서 UserVoice 사용자 의견 보내기를 통해 의견을 보내 주시기를 부탁드립니다.

앞으로 몇 개월 동안은 Dynamics 365, Windows Server, SQL Server, System Center 및 Windows 데스크톱에 대한 추가 콘텐츠가 제공될 수도 있습니다.

이 게시물

  • 문서 주요 기능
  • 새 문서 기능
  • Azure 설명서
  • Visual Studio 2017 RC 설명서
  • C++ 설명서
  • ASP.NET Core 설명서
  • Entity Framework Core 설명서
  • SQL on Linux 설명서

문서 주요 기능

여기서는 docs.microsoft.com에 대해 익숙하지 않은 사용자를 위해 새로운 환경의 몇 가지 주요 특징을 소개합니다.

예상 읽기 시간과 마지막 업데이트 시간

사용자 의견에 따른 간단한 개선 사항으로 문서의 예상 읽는 시간을 제공합니다. 많은 사용자가 모임 사이의 몇 분간 기술을 파악하고 평가하며 얼마의 시간 투자가 필요한지 아는 경우 문서를 읽을 가능성이 많습니다.

콘텐츠가 얼마나 최신인지 고객이 알 수 있도록 콘텐츠에 타임 스탬프를 추가했습니다. 따라서 마지막으로 문서가 업데이트된 시점을 더 이상 추측할 필요가 없습니다.

screenshot1

반응형 디자인

모바일 디바이스, 태블릿 및 PC에서 최상의 환경을 제공하기 위해 반응형 레이아웃을 구현했습니다. 화면이 작은 디바이스에서 페이지 맨 위에 있는 옵션 단추를 클릭하면 데스크톱 브라우저에서 보는 것과 동일한 옵션에 액세스할 수 있습니다.

screenshot2

글로벌 문서

저희는 전 세계의 고객들로부터 지역화된 콘텐츠의 중요성을 여러 번 들었습니다. 이제 docs.microsoft.com에서는, 지역화된 문서가 제공되지 않고 대체 논리를 포함하는Dynamics 365 콘텐츠에 대해, 아랍어 및 히브리어 등 오른쪽에서 왼쪽으로 읽는 언어를 비롯한 45개 언어는 물론, 총 63개 로캘을 지원합니다. 따라서 MS 문서의 진정한 글로벌화가 이루어지고 새해에 발표될 추가 콘텐츠를 준비할 수 있게 되었습니다.

screenshot3screenshot4

보조 노트 및 의견

여러분의 질문, 의견 및 피드백은 중요합니다. Microsoft는 Livefyre와 협력하여 모든 문서에 의견과 보조 노트를 제공합니다. 모든 문서 맨 위에는 의견 섹션으로 직접 이동할 수 있는 옵션이 표시됩니다.

Microsoft는 고객의 의견에 귀기울이며 Docs 페이지에 남긴 모든 의견과 질문을 모니터링하면서 답변해 드리기 위해 최선을 다하고 있습니다.

screenshot5

의견을 남기시려면 기존의 Twitter, Facebook, Google, Yahoo 또는 Microsoft 자격 증명을 사용하여 로그인합니다.

screenshot6

또한, 후속 처리가 예상되는 스레드를 팔로우할 수 있으므로 Microsoft 팀이나 커뮤니티 구성원 중 한 사람이 여러분께 답변을 드릴 때마다 항상 알 수 있습니다.

screenshot7

각 콘텐츠 단락 또는 구체적으로 강조 표시된 텍스트에 보조 노트를 추가할 수도 있습니다. 이렇게 하려면 단순히 마우스 커서로 텍스트 청크를 선택하거나 마우스 커서를 이동할 때 단락의 오른쪽에 나타나는 의견 아이콘을 클릭합니다.

screenshot8

소셜 공유

페이지 맨 위에 있는 공유 단추를 사용하면 Twitter 팔로워 및 Facebook 친구와 콘텐츠를 쉽게 공유할 수 있습니다.

screenshot9

또한 상황에 맞는 위젯을 통해 공유할 콘텐츠를 마우스로 직접 선택할 수도 있습니다.

screenshot10

밝음/어두움 테마

또한 밝은 테마와 어두운 테마 간에 변경할 수 있도록 테마 [asked for on UserVoice](https://msdocs.uservoice.com/forums/364242-general-site-feedback/suggestions/14999211-komplete-dark-theme)선택기를 추가했습니다.

screenshot12

친숙한 URL

웹 환경에 관심을 기울이면서 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

커뮤니티 기여

Microsoft 사이트에 게시되는 대부분의 문서는 커뮤니티 기여를 허용합니다. 오른쪽 위 메뉴의 편집 단추를 클릭하기만 하면 해당 GitHub 페이지로 이동하여 리포지토리의 사본을 만든 다음 내용을 변경하고 끌어오기 요청을 제출할 수 있습니다. Microsoft에서는 지역화된 콘텐츠에 대한 편집과 전반적인 기여 경험에 대한 여러분의 피드백을 기다리고 있습니다!

screenshot13

새 문서 기능

이러한 기능 중 대부분은 5월 출시일부터 제공된 반면, 아래 설명된 새 기능도 추가되었습니다.

실시간 목차 필터

목차를 즉시 필터링할 수 있도록 했습니다. 다시 말해서 몇 문자만 입력하면 일치하는 텍스트를 필터링하여 검색 중인 내용을 쉽게 찾을 수 있습니다.

screenshot14

목차 왼쪽 탐색

여러 사이트에서 콘텐츠의 문제를 해결하는 기능을 또 한 가지 주요 기능으로 추가했습니다. Azure App Service에 ASP.NET 앱 배포하는 방법에 대한 문서를 Azure에 나열해야 할까요? 아니면 ASP.NET에 나열해야 할까요? 대답은 둘 다입니다. 단, 발견 가능성과 일관성의 이유로 두 사이트 섹션에서 콘텐츠가 중복되지 않아야 합니다.

이렇게 하기 위해 콘텐츠 팀이 docs에서 콘텐츠를 선택하여 고객을 위해 해당 콘텐츠의 보기를 만들 수 있도록 했습니다. 아래 그림은 Azure, ASP.NET, .NET Core 및 Visual Studio Azure SDK 팀의 콘텐츠를 모두 단일 보기 안에 포함할 수 있는 Docker를 사용하여 .NET개발자용으로 만들 수 있는 가상 레이아웃을 보여 줍니다.

screenshot15

안정형 코드 샘플

설명서에서 가장 답답함을 느끼는 부분 중 하나는 제시되었거나 연결된 샘플이 해당 컴퓨터에서 실제로 작동하지 않는 경우입니다. Microsoft는 수천 개의 코드 샘플 및 조각을 보유하고 있으며 고객이 지원되는 플랫폼과 구성에서 이러한 샘플의 작동을 신뢰할 수 있기를 바랍니다.

그래서 주어진 운영 체제 및 도구 체인 집합에 대해 샘플을 컴파일하고 예상 출력을 생성하기 위한 확장형 CI(연속 통합) 시스템을 개발했습니다. Microsoft에서는 이 작업에 더 많은 팀을 투입하는 한편, 코드를 다운로드하는 사용자에게 해당 코드가 모든 필요한 품질 검사를 통과했다는 확신을 드리고 싶습니다.

통합된 참조 콘텐츠

Microsoft에서는 다양한 플랫폼 및 형식에 대한 언어 바인딩을 포함하도록 docs.microsoft.com을 구동하는 오픈 소스 구성 요소인 기본 DocFX 엔진을 다시 디자인했습니다. 여기에는 다음에 대한 지원이 포함됩니다.

  • Azure CLI(Python)
  • PowerShell
  • .NET 및 .NET Core
  • Java
  • Swagger/REST Api

고객에게 이는 이제 문서와 코드 모두를 구동하는 진정한 단일 소스가 있으므로 설명서가 API 기능과 동기화되지 않은 상태로 더 이상 표류하지 않을 것임을 의미합니다. 아래 Azure 및 ASP.NET/EF 섹션에서 API 참조에 대한 구체적인 지원에 대해 자세히 알아볼 수 있습니다.

PDF 지원

PDF 지원은 고객이 원했던 주요 기능 중 하나로, 기가바이트 수준의 공간을 차지 않으면서 데스크톱이든 모바일 디바이스든, 어디서나 특정 문서 집합을 다운로드하여 활용할 수 있습니다.

이러한 지원을 제공하기 위해 목차에 대한 PDF 지원을 허용했습니다. 실시간 사이트에서 목차가 업데이트될 때 PDF 파일이 업데이트되도록 하였으므로 언제나 수많은 최상의 최신 콘텐츠를 볼 수 있습니다.

<img alt="screenshot16]()

Azure 설명서

고객으로부터 환경 관련 문제와 조각화에 대한 피드백이 있었으므로 Azure 기술 설명서를 azure.microsoft.com, MSDN, GitHub에서 마이그레이션하고 https://docs.microsoft.com/azure/에 통합하는 작업을 진행했으며 이제 거의 막바지에 이르렀습니다.

새 Azure 허브 페이지

또한 Azure 콘텐츠 방문 페이지의 모양과 느낌을 변경할 기회도 얻었습니다. 주요 특징은 다음과 같습니다.

  • 서비스 탭 - 범주별로 그룹화된 Azure 서비스가 나열됩니다.
  • 개발자 탭 - REST API, Azure .NET SDK, Azure Java SDK, Azure CLI 및 Azure PowerShell에 대한 모든 Azure 참조 콘텐츠를 나열합니다.
  • 아키텍처 탭 - 설계자와 개발자가 클라우드 규모의 디자인 패턴을 배울 수 있습니다.
screenshot17

새 서비스 페이지

방문 페이지가 일관성 있고 다음과 같은 주요 리소스에 연결되도록 하였습니다.

  • 서비스 개요 링크입니다.
  • 모든 관련 플랫폼과 프로그래밍 언어에 대한 시작 자습서입니다.
  • 지정된 서비스에 대한 모든 비디오 자습서의 링크입니다.
  • API 참조 콘텐츠의 링크입니다.
  • 해당 서비스에 대한 모든 설명서를 다운로드할 수 있는 링크입니다.
screenshot18

새 목차

Microsoft에서는 docs.microsoft.com/azure로 전환하는 이 시점을 목차 탐색에 대한 일관성을 개선할 기회가 삼고 있습니다. 각 서비스마다 고유한 특성은 있지만, 이제는 사이트 내에서 이동할 때 비슷한 방식으로 탐색할 수 있습니다.

색 지정 개선

Azure 명령줄 인터페이스(Command Line InterfaceCLI)를 나타내는 코드 샘플의 경우, 코드를 보다 쉽게 읽고 이해할 수 있도록 키워드 및 매개 변수에 대한 색 지정을 추가했습니다.

screenshot19

참조 개선

모든 고객으로부터 들어왔던 가장 큰 문제점 중 하나는 API, 명령줄 및 PowerShell 콘텐츠가 최신 상태로 업데이트되지 않는다는 것입니다. 레거시 설명서 워크플로가 Azure 변환 속도만큼 신속하게 작동하지 않습니다.

이 번 릴리스에서는 참조를 소스 코드에서 직접 만들도록 시스템을 변경했습니다. 새 빌드가 제공될 때 새 콘텐츠도 제공됩니다. Microsoft의 방법 콘텐츠에 참여할 수 있는 것처럼, 설명서의 자동 생성 부분에도 똑같이 참여할 수 있습니다.

또한 Open API 사양(이전에는 Swagger라고 함)을 표준화하여 REST API를 설명하고 있습니다. 따라서 이제는 설명서와 클라이언트 SDK에 모두 사용할 수 있는 REST 서비스에 대한 데이터 표현이 일관성을 유지하게 됩니다. 또한 추후에는 REST 설명서와 예제 요청/응답 페이로드에 대화형 기능을 추가할 수도 있을 것입니다.

이 번 릴리스에서는 다음을 사용할 수 있습니다.

screenshot20screenshot21

Visual Studio 2017 RC 설명서

새롭게 업데이트된 docs.microsoft.com 환경에 직접 통합된 모든 Visual Studio 설명서를 소개합니다.

새 Visual Studio 허브 페이지

Visual Studio 허브 페이지에는 Visual Studio 2017의 Release Candidate를 시작하기 위한 주요 링크가 포함되어 있습니다.

여기에는 설치 설명서, 새로운 기능 및 시작 자습서가 포함됩니다. 지역화된 콘텐츠가 곧 제공될 예정입니다. 리팩터링, 프로젝트에 포함되지 않은 코드 작업, 성능 문제 디버깅, 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 Core 및 Entity Framework Core는 오픈 소스 프로젝트이므로 이와 관련된 소스 코드와 /// 주석을 세부적으로 통합하여 개별 API 설명서를 만들었습니다. 다시 말해서 API와 설명서가 항상 자동으로 동기화 상태를 유지합니다.

C++ 설명서

고객의 오랜 요청에 따라 주제 간에 링크가 거의 필요하지 않은 보다 간소한 형식으로 C++ 참조를 리팩터링했습니다. 이제는 클래스와 동일한 주제에서 클래스 멤버에 대한 모든 문서를 찾아볼 수 있습니다.

또한, 최신 C++ 표준 규정 변경 사항과 새로운 빌드 옵션(예: /fastlink)에 대한 자세한 정보를 알아보고, 이전 Visual Studio 버전에서 코드 업그레이드하는 방법에 대한 새로운 이식 지침을 사용하며, 새로 추가된 gcc를 사용한 Lunux 시스템의 빌드 지원 기능을 테스트하는 방법을 찾아볼 수 있습니다!

SQL on Linux 설명서

여기서는 SQL Server on Linux(SQL Server vNext Customer Technical Preview 1의 일부)를 체험해 보실 수 있습니다! 허브 페이지에는 Linux on SQL Server 관리 및 개발을 시작할 수 있도록 도와드릴 주요 링크가 포함되어 있습니다. 지역화된 콘텐츠가 곧 제공될 예정입니다.

결론

Microsoft에서는 새 설명서 사이트에 더 많은 기능을 제공하고 Microsoft의 제품 및 서비스에 맞는 환경을 만들기 위해 노력하고 있습니다. 사용자는 설명서 프로세스에서 가장 중요한 부분이기 때문에 Microsoft에 연락하여 Twitter에서 이 환경을 더 잘 만들 수 있는 방법에 대한 피드백을 제공하는 것이 좋습니다.