새로운 피드백 시스템이 docs.microsoft.com

이 게시물은 docs.microsoft.com 팀의 수석 프로그램 관리자인 롭 아이젠버그의해 작성되었습니다.

Microsoft의 임무는 전 세계의 모든 사용자와 모든 조직이 더 많은 성과를 거둘 수 있도록 하는 것입니다. 이는 열려 있는 GitHub 플랫폼 기반으로 docs.microsoft.com 빌드할고려 사항 중 하나입니다. 현재 새 GitHub 기반 설명서 피드백 시스템으로 전환하여 다음 단계로 넘어가고 있습니다.

GitHub의 콘텐츠 피드백

설명서는 처음부터 GitHub에 있었지만 콘텐츠 피드백 메커니즘은 아티클에 대한 주석에 Livefyre를 사용하고 있습니다. Livefyre는 훌륭한 주석 처리 솔루션이지만, 고객이 제기한 콘텐츠 문제를 추적하고, 소유자를 할당하고, 유지 관리하는 특정 요구 사항에 충분하지 않은 것으로 밝혀졌습니다.

우리는 더 나은 만들기 위해 여러 가지 방법을 모색했지만, 많은 작업을 안내한 한 가지 질문은 다시 떠오르는 것처럼 보였습니다: 설명서가 오픈 소스 코드처럼 취급된다면 이 문제를 해결하기 위해 무엇을 사용할 수 있을까요? 질문에 대한 대답은 분명해 보였습니다. GitHub 문제GitHub API를 문서 페이지에 더 깊이 통합하여 GitHub 인프라를 기반으로 전체 피드백 시스템을 빌드할 수 있는 실험을 시작했습니다.

이제 새 시스템을 사용하여 콘텐츠 페이지에서 직접 GitHub 문제를 만들 수 있으므로 작성자 및 제품 팀과 훨씬 더 풍부한 방식으로 상호 작용할 수 있습니다. 문서에 문제가 있나요? 잘못된 코드 샘플인가요? 혼란스러운 설명? 중요한 누락? 페이지 아래쪽으로 스크롤하여 설명서 피드백 선택합니다.

문서 페이지 자체에서 직접 문서와 관련된 열려 있고 닫힌 모든 문제를 볼 수 있습니다. 이렇게 하면 문제가 해결되고 해결될 때 항상 알 수 있습니다.

댓글을 달고 중요한 문제에 반응을 추가할 수도 있습니다.

이제 Microsoft 직원은 GitHub 문제의 모든 기능을 활용하여 보고된 문제를 심사, 대응, 계획 및 수정할 수 있으며, 항상 프로세스에 대한 가시성을 갖게 됩니다.

예제 설명서 피드백

아티클에서 끊어진 하이퍼링크에 대한 GitHub 문제를 제출한다고 가정해 보겠습니다. 우리 팀은 문제를 심사하고, 레이블을 할당하고, 소유자를 할당하여 수정을 수행합니다(또는 후속 질문). 소유자가 문제를 해결하는 끌어오기 요청을 제출하면(GitHub 알림 설정에 따라) 문제가 해결/닫혔음을 알리고 피드백의 선순환을 만듭니다.

또한 메모의 Markdown, 개별 문제 또는 전체 리포지토리에 대한 구독, 조직 활동의 RSS 피드, @ 멘션, 담당자 등과 같은 모든 표준 GitHub 선도를 활용할 수 있습니다. 우리는 오픈 소스 도구 통합의 더 깊은 수준이 지역 사회 성장과 협력을위한 새로운 기회를 촉진 할 것이라고 생각합니다.

제품 피드백 분리

이전 시스템의 문제 중 하나는 한 스트림에서 제품과 설명서 피드백 간의 혼합이었습니다. 모든 항목이 일관되게 레이블이 지정되지 않은 경우 심사 및 후속 조치가 매우 어려웠습니다. 다음 두 가지를 구분하는 명확한 방법을 만들어 이 문제를 해결하기 위해 한 걸음 앞으로 나아갔습니다.

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

Roll-Out

피드백 시스템이 언제 라이브 상태가 될지 궁금할 수 있습니다. 이제 Visual Studio IDE Azure CLI 설명서 몇 달 동안 파일럿을 수행했습니다. 2월 중순부터 모든 docs.microsoft.com 배포하기 시작합니다.

사용자 의견

귀하의 피드백은 우리에게 중요하므로 이 새로운 시스템을 신속하게 파악하고자 합니다. 플랫폼에 대한 피드백과 참여를 개선하는 다음 단계이지만, 이는 우리의 마지막 단계가 아닙니다. GitHub 변경대한 의견을 보내거나 Twitter 태그를 지정해야 합니다.