컨셉 주제 유형

컨셉은 단일 기능 또는 개념을 소개합니다.

컨셉은 다음 질문에 대답해야 합니다:

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

이 개념을 듣지 못한 사람이 알고 싶어할 모든 것을 생각해보세요.

이 일을 하는 방법이 아닌, 그것이 무엇인가 알려줍니다.

만약 다른 개념을 설명하기 시작한다면, 새로운 개념을 시작하고 링크를 제공하세요.

형식

컨셉은 이 형식을 따라야 합니다:

# 제목 (명사, "Widgets"와 같은)

이것이 무엇이며 사용 목적을 설명하는 한두 단락.

만약 다른 개념을 설명하기 시작한다면, 중단하세요.
각 컨셉은 **하나의 개념에 대해** 되어야 합니다.

**그것을 사용하는 방법**을 설명하기 시작한다면, 중단하세요.
작업 주제는 어떻게 뭔가를 사용하는 방법을 설명하며, 컨셉 주제는 아닙니다.

관련된 작업에 대한 링크를 포함하지 마세요. 내비게이션에 작업에 대한 링크가 제공됩니다.

컨셉 주제 제목

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

  • 위젯
  • GDK 의존성 관리

보다 구체적인 단어가 필요하다면 ing 대신 ion 버전의 단어를 사용하세요. 예를 들어:

  • 객체 이관 대신 객체 마이그레이션

ing으로 끝나는 단어는 번역하기 어렵고 공간을 더 차지하며, 작업 주제에는 적극적인 동사가 사용됩니다. 자세한 내용은 Google 스타일 가이드를 참조하세요.

피해야 할 제목

다음과 같은 주제 제목을 피해주세요:

  • 개요 또는 소개. 대신, 누군가가 검색할 것으로 예상되는 보다 구체적인 명사 또는 구문을 사용하세요.
  • 사용 사례. 대신, 정보를 컨셉의 일부로 포함하세요.
  • 작동 방식. 대신, 명사 뒤에 작업 흐름을 붙이세요. 예를 들어, Merge Request 작업 흐름.