새로운 피드백 시스템이 docs.microsoft.com에 제공됩니다.

이 게시물은 docs.microsoft.com 팀의 선임 프로그램 관리자인 Rob Eisenberg가 작성했습니다.

Microsoft는 전세계의 모든 사용자와 조직이 더 많은 일을 해낼 수 있도록 돕고자 합니다. 오픈 GitHub 플랫폼을 기반으로 docs.microsoft.com을 빌드하면서 고려한 부분입니다. 오늘 새 GitHub 기반 설명서 피드백 시스템으로 이동하여 다음 수준으로 업데이트합니다.

GitHub의 콘텐츠 피드백

처음부터 설명서가 GitHub에 위치한 반면 콘텐츠 피드백 메커니즘은 아티클의 주석에 대해 Livefyre를 사용했습니다. Livefyre가 우수한 주석 솔루션이지만 고객에 의해 발생한 콘텐츠 문제를 추적하고, 소유자를 할당하고, 상태를 유지 관리하는 특정 요구 사항에 충분하지 않다는 것이 밝혀졌습니다.

이를 개선하기 위해 다양한 환경을 살펴보았지만 대부분의 작업에서 한 가지 질문이 다시 떠올랐습니다. 설명서를 오픈 소스 코드와 마찬가지로 다루는 경우 이 문제를 해결하기 위해 무엇을 사용해야 할까요? 질문에 대한 답은 GitHub 이슈로 명확했습니다. 따라서 GitHub 인프라를 기반으로 전체 피드백 시스템을 구축할 수 있도록 GitHub API를 설명서 페이지에 심층적으로 통합하는 실험을 시작했습니다.

이제 새로운 시스템을 사용하여 콘텐츠 페이지에서 직접 GitHub 문제를 만들 수 있습니다. 그러면 작성자 및 제품 팀과 더 다양한 방식으로 상호 작용할 수 있게 됩니다. 문서에서 문제가 표시되나요? 코드 샘플에 문제가 있나요? 설명이 혼란스러운가요? 중요한 내용이 생략되었나요? 페이지 맨 아래로 스크롤하고 설명서 피드백 제공을 선택하기만 하면 됩니다.

설명서 페이지에서 직접 문서와 연결된 모든 열려진 문제 및 종결된 문제를 확인할 수 있습니다. 이런 방식으로 수정되고 해결된 문제를 언제든지 알 수 있습니다.

중요한 문제에 주석을 처리하고 반응을 추가할 수도 있습니다.

이제 Microsoft 직원은 GitHub 문제의 모든 기능을 활용하여 보고된 문제를 심사하고, 대응하고, 계획하고, 수정할 수 있습니다. 또한 이 프로세스를 항상 확인할 수 있습니다.

예제 설명서 피드백

아티클에서 끊어진 하이퍼링크에 관한 GitHub 문제를 파일링한다고 가정해 보겠습니다. 팀에서는 수정하기 위해 문제를 심사하고, 레이블을 할당하고, 소유자를 할당(또는 후속 내용을 질문)합니다. 소유자가 문제를 수정하는 끌어오기 요청을 제출하는 경우 (GitHub 알림 설정에 따라) 문제가 해결/마감되었다는 알림이 표시되며 피드백의 선순환 주기를 생성합니다.

또한 주석의 Markdown, 개별 문제 또는 전체 리포지토리에 대한 구독, 조직 작업의 RSS 피드, @ 멘션, 피할당자 등 모든 표준 GitHub 적합성을 활용할 수 있습니다. 심층적인 오픈 소스 도구 통합이 커뮤니티 성장 및 협업을 위한 새로운 기회를 촉진한다고 믿습니다.

제품 피드백의 분리

하나의 스트림에서 제품과 설명서 피드백이 혼합되는 것이 이전 시스템의 문제 중 하나였습니다. 일부 항목의 레이블이 일관되게 지정되지 않은 경우 심사하고 따라가기가 매우 어려웠습니다. 두 가지를 구분하는 명확한 방법을 만들어서 이 문제를 해결하도록 노력했습니다.

이제 제품 피드백 제공을 클릭하여 특정 설명서 페이지와 연결된 제품 팀이 제품 피드백을 처리하는 사이트로 직접 이동합니다.

롤아웃

피드백 시스템이 라이브인 경우를 궁금할 수 있습니다. Visual Studio IDE 및 Azure CLI 설명서에서 몇 달 동안 실험해 보았습니다. 2월 중순부터는 docs.microsoft.com 전체에서 롤아웃하기 시작합니다.

사용자 피드백

사용자 피드백이 중요하므로 이 새로운 시스템을 신속하게 설치해주세요. 이 기능은 플랫폼에서 피드백 및 참여를 개선하기 위한 다음 단계이며 계속 노력하겠습니다. GitHub에서 변경 내용에 대한 의견을 알려주시거나 Twitter에서 태그를 지정해 주세요.