토픽 정보

토픽은 문서를 필터링하는 데 사용되며 GitHub Docs 사이트에서 검색할 수 있습니다. 방문 페이지 또는 안내선과 같은 일부 레이아웃의 경우, 토픽을 필터링하여 표시되는 문서를 선택할 수 있습니다. 다음 지침을 사용하여 문서의 프런트 매터에 추가할 항목을 선택할 수 있습니다. 문서에 항목을 추가하는 방법에 대한 자세한 내용은 ‘토픽’을 참조하고, 허용되는 모든 토픽 목록에 대한 자세한 내용은 allowed-topics을(를) 참조하세요.

모든 콘텐츠 형식에 대한 토픽

• 모든 문서에는 하나 이상의 토픽이 있어야 합니다.
• 토픽으로 명사를 사용하세요.
• 토픽은 사람들이 콘텐츠를 의미 있게 그룹화할 수 있도록 도와줍니다.
  • 가능하면 광범위한 토픽뿐만 아니라 관련성이 있는 보다 구체적인 토픽을 사용하세요. 예를 들어 단순히 API을(를) 사용하기보다는 REST 또는 GraphQL을(를) 사용하는 것입니다.
  • 유사한 문서의 토픽이 일관성이 있게 하여 토픽별로 필터링하는 사용자가 모든 관련 문서를 가져올 수 있도록 확인하세요. 예를 들어, CI에 관한 모든 문서에는 CI 토픽에 더하여 더 구체적인 토픽이 있어야 합니다.
  • 모호한 토픽을 피합니다. 예를 들어 Actions은(는) Actions 제품 내에서 유용한 토픽이 아닐 수 있는데, 왜냐하면 그것이 제품 GitHub Actions 또는 동작이라고 부르는 제품 요소를 참조할 수 있기 때문입니다.
• 토픽은 값을 추가하며 문서의 제목, 유형 또는 범주를 복제하지 않습니다.
  • 예를 들어 Actions 제품 내에서 Actions은(는) 값을 추가하지 않는데, 왜냐하면 해당 문서의 이 구역에서 누군가가 이미 그들이 Actions 문서를 보고 있음을 알 것이기 때문입니다.
• 제품 영역의 핵심 개념과 관련된 문서에 Fundamentals을(를) 사용하세요.
  • 사용하세요: ‘GitHub Actions에 대한 소개’와 같은 문서에서의 Fundamentals
  • 피하세요: ‘GitHub Actions에 대한 소개’와 같은 문서에서의 Actions
• 일반적으로 인식되는 약어는 사용할 수 있지만, 애매하거나 모호한 약어는 피해야 합니다.
  • 사용: Continuous integration 대신 CI
  • 피하세요: Advanced Security 대신 AS
• GitHub 제품 이름의 짧은 형식을 사용하세요.
  • 사용: GitHub Actions 대신 Actions

토픽을 선택하기 위한 체크리스트

문서 토픽을 선택하는 데 도움이 되도록 다음 질문을 고려하세요. 모든 문서에 체크리스트의 각 항목에 대한 토픽이 있는 것은 아닙니다.

• 기능 또는 제품 영역이 무엇인가요?
  • 예시: Enterprise 하위 기능에 대한 문서인가요(제품 이름이 기능 이름과 일치하지 않는 한)?
  • 예: Dependabot
• 해당 기능이 제한된 프로그램의 일부인가요?
  • 예: Advanced Security
• 이 문서는 기능 또는 제품의 요소가 무엇인가요?
  • 예: Organizations
• 이 문서의 광범위한 목적은 무엇인가요?
  • 예: Permissions
• 이 문서에서 명시적으로 언급하는 프로그래밍 언어, 패키지 관리자 또는 에코시스템은 무엇인가요? 문서에서 지원하는 언어, 패키지 관리자 또는 에코시스템을 나열하는 경우뿐만 아니라, 문서를 필터링하는 사람에게 값을 추가하는 경우에만 이러한 항목을 포함하세요.
  • 예: Ruby