GitHub 문제를 사용하여 설명서 검토

  • 4분

Microsoft Learn에 기여하는 가장 유용한 방법 중 하나는 설명서 문서에 직접 피드백을 제공하는 것입니다. 둘러보면서 편집, 제안에 대한 아이디어나 질문 또는 기타 인사이트가 떠오를 때 페이지의 피드백 링크를 사용하여 제공할 수 있습니다. Microsoft Learn 설명서의 대부분의 콘텐츠는 GitHub 리포지토리에 저장되므로 GitHub 문제 제출이라는 GitHub 프로세스를 사용하여 피드백을 제공할 수 있습니다.

GitHub 문제는 기술 사용자, 엔지니어 및 기타 Microsoft Learn 방문자가 특정 문서에 대한 피드백을 공유하고 추적할 수 있는 도구입니다. 양식을 작성하여 피드백을 문서화하고 GitHub의 원본 문서 리포지토리에 게시하면 작성자 또는 소유자에게 알림이 표시됩니다. GitHub 리포지토리를 방문하는 모든 사용자가 문제를 볼 수 있습니다. 버그 보고, 기능 요청 또는 메모와 같은 중요한 피드백을 수집하고 저장하는 유용한 방법입니다.

GitHub에서 콘텐츠를 리뷰하는 이유는 무엇인가요?

GitHub에서 콘텐츠 리뷰를 제공하는 것은 열정이나 지식을 갖고 있는 주제에 직접 기여하는 방법입니다. 이는 Microsoft 설명서에서 주제를 탐색하면서 아이디어를 추가할 수 있음을 뜻합니다. 지식 풀에 인사이트를 제공하면 수백만 명의 다른 사용자를 위해 Microsoft 제품 환경을 개선하는 데 도움을 줄 수 있습니다. 피드백은 Microsoft 제품 및 지원 콘텐츠를 사용하는 다른 Microsoft Learn 방문자를 위해 콘텐츠를 개선합니다.

대부분의 경우 GitHub 피드백을 제출함으로써 제품의 콘텐츠 세트를 담당하는 팀에 아이디어를 보낼 수 있습니다. 콘텐츠 팀과 제품 사용자 간의 이 협업 경로를 통해 GitHub에서 직접 피드백을 공유하고 논의할 수 있습니다.

설명서 콘텐츠에 기여하면 본인의 경력에도 도움이 됩니다. GitHub는 기술을 기여하고, 또 기여한 기술을 추적할 수 있는 플랫폼으로 유명합니다. GitHub에서 프로젝트에 참여할 때마다 GitHub 프로필에 반영됩니다. 시간이 지남에 따라 기술 포트폴리오에 기여 기록을 추가해서 작성할 수 있습니다.

콘텐츠에 대한 피드백을 제공하는 방법

Microsoft Learn에 있는 많은 설명서 문서가 GitHub 리포지토리에 저장됩니다. 많은 GitHub 리포지토리에는 GitHub 문제가 활성화되어 있습니다. 활성화하면 learn.microsoft.com 문서의 맨 아래에서 이 페이지에 대한 피드백을 제출하는 옵션을 찾을 수 있습니다.

Screenshot of the feedback options at the bottom of a documentation article.

문제를 만들고 제출하려면 GitHub 계정이 필요합니다. Microsoft Learn 문서에서 GitHub에서 문제를 제출하는 방법은 다음과 같습니다.

  1. GitHub 계정으로 로그인합니다.

  2. 피드백을 제공하려는 Microsoft Learn 설명서 문서로 이동합니다.

  3. 문서의 맨 아래에서 피드백 레이블이 붙은 제목을 찾습니다. 여기에 이 페이지에 레이블이 붙은 상자가 표시됩니다.

    • 문서 자체에 대한 피드백을 제공하려면 이 페이지를 선택합니다. 이렇게 하면 GitHub의 빈 문제 양식으로 이동하여 댓글을 작성할 수 있습니다. 이제 이 옵션을 선택합니다.
    • 해당 주제에 대해 제출된 다른 GitHub 문제를 살펴보려면 모든 페이지 피드백 보기를 선택합니다. 누구나 공용 리포지토리에서 다른 GitHub 문제를 읽을 수 있지만 GitHub 계정이 있으면 문제에 의견을 제시할 수 있습니다.
    • 이 제품을 선택하면 제품 자체에 대한 피드백을 제공할 수 있습니다. 지금은 이 옵션에 대해서는 자세히 설명하지 않고 설명서 자체에 대한 피드백 제공을 중점적으로 다루겠습니다.

  4. 이 페이지를 선택했는데 아직 로그인하지 않은 경우 GitHub 계정에 로그인하라는 메시지가 표시됩니다. 그런 다음 GitHub에 빈 문제 피드백 양식이 나타납니다.

  5. 내용을 간략하게 요약하는 피드백 제목을 입력합니다.

  6. 아래 텍스트 상자에서 피드백 내용을 입력하고 필요한 컨텍스트를 제공합니다. 도구 모음을 사용하여 인용, 목록 또는 멘션 추가 등 설명의 서식을 지정합니다.

  7. 완료되면 새 문제 제출을 선택합니다.

Screenshot of a blank GitHub issues form to submit feedback on a documentation article.

문제 추적

문제를 제출하면 문서의 작성자 또는 기타 콘텐츠 소유자에게 알림이 표시됩니다. GitHub 알림을 확인하거나 리포지토리로 돌아가서 문제 탭을 확인하여 문제에 대한 댓글을 추적할 수 있습니다.

또한 문제 탭에서 해당 리포지토리에 대해 제출한 다른 문제에 대해서도 탐색하고 리뷰 및 의견을 제시할 수 있습니다.

Screenshot of the GitHub issues tab in a GitHub repo.