개념 주제 유형

개념은 단일 기능이나 개념을 소개합니다.

개념은 다음 질문에 답해야 합니다:

  • 이것은 무엇인가요?
  • 왜 이를 사용해야 하나요?

이 개념에 대해 들어본 적이 없는 사람이라면 알고 싶어할 모든 것을 생각해 보세요.

어떻게 하는지 말하지 마세요. 무엇인지 말하세요.

다른 개념을 설명하기 시작하면, 새 개념을 시작하고 그것에 링크를 추가하세요.

형식

개념은 다음 형식으로 해야 합니다:

# 제목 (명사, 예: "위젯")

이것이 무엇이며 왜 사용해야 하는지를 설명하는 단락 또는 두 단락입니다.

다른 개념을 설명하기 시작하면 스스로 멈추세요.
각 개념은 **하나의 개념만** 포함해야 합니다.

**이것을 사용하는 방법**을 설명하기 시작하면 스스로 멈추세요.
작업 주제는 무언가를 사용하는 방법을 설명하고, 개념 주제는 아닙니다.

관련 작업에 대한 링크를 포함하지 마세요. 탐색 메뉴가 작업에 대한 링크를 제공합니다.

개념 주제 제목

제목 텍스트에는 명사를 사용하세요. 예를 들면:

  • 위젯
  • GDK 의존성 관리

더 설명적인 단어가 필요하다면, ing 대신 ion 버전을 사용하세요. 예를 들어:

  • 객체 마이그레이션 대신 객체 마이그레이팅 또는 객체 마이그레이트

ing로 끝나는 단어는 번역하기 어렵고 공간을 더 차지하므로, 작업 주제에는 능동 동사를 사용합니다.

자세한 내용은 구글 스타일 가이드를 참고하세요.

피해야 할 제목

다음 주제 제목은 피하세요:

  • 개요 또는 소개. 대신, 누군가가 검색할 만한 더 구체적인 명사나 구문을 사용하세요.
  • 사용 사례. 대신, 개념의 일부로 정보를 통합하세요.
  • 작동 방식. 대신, 명사 뒤에 워크플로우를 사용하세요. 예: 병합 요청 워크플로우.