컨셉 주제 유형

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

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

  • 이것은 무엇인가요?
  • 사용하는 건가요?

이 컨셉에 대해 이전에 듣지 못한 사람이 원할 수 있는 모든 정보를 생각해 보세요.

어떻게하는 방법을 설명하거나 아니면 그것이 무엇인지를 말해 주세요.

다른 컨셉을 설명하기 시작하면 새로운 컨셉을 시작하고 그것에 링크를 거세요.

형식

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

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

이것이 무엇이며, 왜 사용하는지를 설명하는 한 두 단락.

다른 컨셉을 설명하기 시작하면 중단하세요.
각 컨셉은 **단일 컨셉에 대해**만해야합니다.

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

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

컨셉 주제 제목

제목 텍스트에는 명사를 사용합니다. 예를 들어:

  • 위젯
  • GDK 의존성 관리

더 구체적인 단어가 필요한 경우 ing 대신 ion 버전의 단어를 사용하세요. 예를 들어:

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

ing로 끝나는 단어는 번역하기 어려우며 공간을 더 차지하며, 작업 주제에는 동사가 사용됩니다. 세부 정보는 Google 스타일 가이드를 참조하십시오.

피해야할 제목

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

  • 개요 또는 소개. 대신 더 구체적인 명사 또는 검색할 수 있는 구는 구를 사용하세요.
  • 사용 사례. 대신, 컨셉의 일부로 정보를 통합하세요.
  • 작동 방식. 대신, 명사 뒤에 워크플로우를 사용하세요. 예: Merge Request 워크플로우.