컨셉 주제 유형
컨셉은 단일 기능 또는 개념을 소개합니다.
컨셉은 다음 질문에 대답해야 합니다:
- 이것은 무엇인가요?
- 왜 사용하나요?
컨셉이 처음 접하는 사람이 알고 싶어할 모든 것을 생각해 보세요.
이 일을 하는 방법은 알려주지 마세요. 무엇인지 알려주세요.
만약 다른 컨셉을 설명하기 시작한다면 새로운 컨셉을 시작하고 링크를 걸어주세요.
형식
컨셉은 다음 형식을 따라야 합니다.
# 제목 (명사, "위젯"과 같이)
무엇인지 설명하고 왜 사용하는지를 설명하는 한두 단락.
다른 컨셉을 설명하기 시작하면 멈추세요.
각 컨셉은 **하나의 컨셉에 대해만** 이어져야 합니다.
사물을 사용하는 방법을 설명하기 시작하면 멈추세요.
작업 주제는 어떻게 사용하는지를 설명하며, 컨셉 주제는 아닙니다.
관련 작업에 대한 링크를 포함하지 마세요. 내비게이션에서 작업에 대한 링크가 제공됩니다.
컨셉 주제 제목
제목 텍스트에는 명사를 사용하세요. 예를 들면:
위젯
GDK 의존성 관리
더 자세한 단어가 필요하다면 ing
대신에 ion
버전의 단어를 사용하세요. 예를 들면:
-
객체 이관
대신에객체 이관
-
객체 이관
대신에객체 이전
ing
로 끝나는 단어는 번역하기 어렵고 공간을 더 차지하며, 작업 주제에는 능동적인 동사가 사용됩니다.
세부 내용은 Google 스타일 가이드를 참조하세요.
피해야 할 제목
다음과 같은 주제 제목은 피하세요:
-
개요
나소개
. 대신에 더 구체적인 명사나 검색할 수 있는 구문을 사용하세요. -
사용 사례
. 대신에 정보를 컨셉의 일부로 통합하세요. -
동작 방식
. 대신에 명사 뒤에워크플로우
를 사용하세요. 예를 들면,병합 요청 워크플로우
.