Skip to main content

이 버전의 GitHub Enterprise는 다음 날짜에 중단되었습니다. 2024-09-25. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 더 뛰어난 성능, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise Server로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

검색에서 콘텐츠를 찾을 수 있도록 만들기

사용자가 검색 엔진을 사용하여 GitHub 설명서를 찾는 데 도움이 되도록 다음 SEO 모범 사례를 따릅니다.

검색 엔진 최적화 정보(SEO)

SEO(검색 엔진 최적화)는 Google, Bing 등의 검색 엔진 결과에서 웹 콘텐츠의 가시성을 얻는 방법입니다. Google 검색은 GitHub Docs에 대한 최상위 참조자이며 사용자에게 가장 일반적인 진입점입니다.

SEO를 개선하기 위해 콘텐츠를 계획하고 작성할 수 있습니다. 사용자가 선호하는 검색어를 사용하여 원하는 정보를 찾을 가능성이 높기 때문에 더 나은 SEO는 설명서를 검색하는 사람들의 환경을 개선합니다.

콘텐츠 SEO의 모범 사례

좋은 SEO를 위해서는 특정 대상 그룹에 대한 콘텐츠를 계획하고 그들이 검색하는 데 사용하는 단어에 주의를 기울여야 합니다. 다음 모범 사례를 따라 문서의 SEO를 개선합니다.

대상 그룹을 선택합니다.

콘텐츠에 대한 특정 대상 그룹(개발자, 관리자 또는 코드 학습자)을 이해하고 글을 작성합니다. 이렇게 하면 다음 작업에 도움이 됩니다.

  • 독자가 사용하는 단어를 사용합니다.
  • 독자의 요구 사항 및 작업에 적합한 콘텐츠를 만듭니다.
  • 적절한 양의 컨텍스트 및 배경 정보를 제공합니다.

검색 의도에 응답

검색 의도를 중심으로 콘텐츠를 만듭니다. 검색 의도란 대상 그룹의 구성원이 온라인으로 정보를 검색하도록 유도하는 작업, 질문 또는 문제를 말합니다.

  • 검색 의도 조사를 수행합니다. 예를 들어 관련 쿼리에 대한 검색 엔진 결과 페이지(SERP)를 분석합니다.
  • 사용자 요구 사항을 이해합니다. 고객 피드백, 사용자 인터뷰 및 메트릭과 같은 여러 소스를 사용합니다.

명확한 언어 사용

다음을 포함하여 "GitHub Docs에 대한 모범 사례"의 지침을 따릅니다.

  • 모든 문서에 명확한 개별 주제가 있는지 확인합니다.
  • 문서에서 우선 순위가 높은 콘텐츠를 먼저 배치합니다.
  • 명확한 제목을 사용하여 문서를 구성합니다.
  • "스타일 가이드"에 따라 일관성 있게 콘텐츠를 편집합니다.

키워드 통합

대상 그룹이 가장 많이 사용하는 키워드 또는 상위 검색어를 페이지 복사 및 메타데이터에 통합합니다. 예를 들어 "청구"에 대해 작성하지만 대상 그룹은 주로 "비용" 및 "지불"을 사용하는 경우 해당 용어를 대신 사용합니다.

Google과 Bing은 모두 관련 키워드를 검색하는 데 도움이 되는 키워드 리서치 도구를 제공합니다. 또한 Docs 팀은 Google Search Console 데이터를 참조하여 검색어가 GitHub Docs의 페이지로 연결되는지 파악합니다.

메타데이터 포함

프론트매터에서 전체 메타데이터를 사용합니다. 사용 가능한 값을 보려면 "YAML 프론트매터 사용"을 참조하세요.

GitHub Docs에서 intro 요소는 페이지 부제목으로 표시되고 HTML 메타데이터 설명으로 사용됩니다. 문서 제목은 HTML 페이지 제목으로 사용됩니다. 좋은 SEO:

  • 제목과 intro을(를) 상호보완적이고 키워드가 풍부하게 들어가도록 작성합니다. 리서치에서 어떻게 표현될지 고려하세요.
  • 모든 이미지가 키워드가 풍부한 대체 텍스트와 함께 제공되며, 대체 텍스트는 검색 엔진에서 사용하는 메타데이터이기도 합니다. GitHub Docs 스타일 가이드의 "대체 텍스트"를 참조하세요.

GitHub Docs 스타일 가이드의 "링크"에 따라 GitHub Docs 및 고품질 피어 사이트의 다른 작업 관련 페이지에 검소하게 연결합니다.

리디렉션을 신중하게 유지 관리하여 들어오는 링크가 중단되지 않도록 합니다.

정확도 유지

콘텐츠에 실제 오류, 맞춤법 및 스타일이 없는지 확인합니다. 주기적으로 콘텐츠를 감사하여 끊어진 링크와 같은 오류를 제거하고 불필요한 콘텐츠를 사용 중지합니다. "리디렉션 구성" 항목을 참조하세요.