GitHub Docs에 대한 쓰기

이러한 모범 사례를 따라 사용자에게 친숙하고 이해하기 쉬운 설명서를 만듭니다.

설명서 철학은 우리가 만드는 콘텐츠와 만드는 방법을 안내합니다.

GitHub Docs에 게시된 모든 콘텐츠는 이러한 기본 요구 사항을 충족해야 합니다.

이러한 원칙을 공유하여 GitHub을(를) 사용하는 사용자에게 가장 적합한 콘텐츠를 디자인하고 만듭니다.

설명서는 여러 언어로 번역됩니다. 영어 설명서를 작성하는 방법을 사용하면 번역 품질이 크게 향상될 수 있습니다.

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

GitHub Docs에서는 YAML 프런트매터 및 Liquid 연산자를 사용한 단일 소스 접근 방식을 사용하여 GitHub의 여러 버전을 지원합니다.

Markdown 및 Liquid를 사용하여 콘텐츠 서식을 지정하고, 재사용 가능한 콘텐츠를 만들고, GitHub Docs에 다른 버전에 대한 콘텐츠를 작성할 수 있습니다.

YAML 프론트매터를 사용하여 버전 관리를 정의하고, 메타데이터를 추가하고, 문서의 레이아웃을 제어할 수 있습니다.

이 가이드에서는 GitHub Docs에 대한 사용자 요구를 지원하는 비디오를 만드는 방법을 설명합니다.

여러 콘텐츠 파일에서 참조할 수 있는 재사용 가능한 콘텐츠를 만들 수 있습니다.

GitHub Docs에 스크린샷을 추가하여 사용자가 찾기 어려운 사용자 인터페이스의 요소를 찾는 것을 도울 수 있습니다.

이 가이드에서는 GitHub Docs에 대한 다이어그램을 만드는 시기와 방법을 설명합니다.

도구 전환기를 사용하여 특정 도구를 사용하여 작업을 완료하는 방법을 보여 줄 수 있습니다.

문서의 제목, 버전 또는 위치가 변경되면 현재 내용 보기로 리디렉션을 만들 수 있습니다.

문서의 제목을 변경해야 하는 경우, 이름을 여러 위치에서 업데이트해야 할 수 있습니다.

더 긴 코드 예시에 주석을 추가하여 작업 방식 및 다른 용도로 사용자 지정하는 방법을 설명할 수 있습니다.

이 문서에는 GitHub Docs에 사용되는 다양한 콘텐츠 유형에 대한 시작 템플릿이 포함되어 있습니다.