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

개념 토픽은 다음 질문에 답해야 합니다.

• 이것이 무엇인지
• 왜 사용하는지

이 개념을 처음 접하는 사람이 알고 싶어 할 모든 내용을 생각합니다.

방법을 설명하지 않고 그것이 무엇인지 설명합니다.

다른 개념을 설명하게 된다면 새 개념 토픽을 시작하고 링크로 연결합니다.

형식#

개념 토픽은 다음 형식으로 작성합니다.

title: Title (a noun, like "Widgets")
---

A paragraph or two that explains what this thing is and why you would use it.

If you start to describe another concept, stop yourself.
Each concept should be about one concept only.

If you start to describe how to use the thing, stop yourself.
Task topics explain how to use something, not concept topics.

Do not include links to related tasks. The navigation provides links to tasks.

개념 토픽 제목#

제목 텍스트에는 명사를 사용합니다. 예를 들어 다음과 같습니다.

• Widgets
• GDK dependency management

더 설명적인 단어가 필요하다면 ing 형태 대신 ion 형태의 단어를 사용합니다. 예를 들어 다음과 같습니다.

• Migrating objects 또는 Migrate objects 대신 Object migration

ing로 끝나는 단어는 번역하기 어렵고 공간을 더 차지하며, 능동형 동사는 태스크 토픽에 사용합니다. 자세한 내용은 Google 스타일 가이드를 참고합니다.

피해야 할 제목#

다음 토픽 제목은 피합니다.

• Overview 또는 Introduction. 대신 사람들이 검색할 만한 더 구체적인 명사나 구를 사용합니다.
• Use cases. 대신 해당 정보를 개념의 일부로 포함합니다.
• How it works. 대신 명사 뒤에 workflow를 붙입니다. 예를 들어 Merge request workflow 입니다.

예시#

수정 전#

다음 토픽은 모든 독자에게 모든 것을 담으려 했습니다. 그룹에 대한 정보와 그룹을 찾는 위치를 함께 제공했고, UI에서 이미 보이는 내용을 다시 설명했습니다.

수정 후#

내용을 개념과 태스크로 나누면 훑어보기가 더 쉬워집니다.

개념#

태스크#