효과적인 제목 쓰기

제목은 문서의 핵심 내용을 간결하고 명확하게 전달해야 합니다. 독자가 문서를 스캔하면서 빠르게 내용을 파악할 수 있도록, 명확하고 검색하기 쉬운 제목을 작성하는 것이 중요합니다.

1. 가독성이 높아져요

제목이 명확하고 간결하면 독자가 문서를 빠르게 스캔할 수 있습니다. 문서의 주제를 한눈에 파악할 수 있도록 제목을 직관적으로 작성해야 합니다.

2. 검색과 탐색이 쉬워져요

제목에 핵심 키워드가 포함되면 검색 엔진에서 문서를 찾기 쉬워집니다. 또한, 문서 내에서도 독자가 원하는 정보를 빠르게 찾을 수 있습니다.

3. 문서의 일관성을 유지할 수 있어요

제목의 스타일이 일관되면 문서가 더 체계적으로 보이며, 독자가 다른 문서와의 관계를 쉽게 이해할 수 있습니다.

체크리스트

✅ 제목에는 핵심 키워드를 포함하세요

문서의 주요 내용을 빠르게 전달할 수 있도록, 독자가 검색할 가능성이 높은 핵심 키워드를 넣어요.

Don't

# 에러를 해결하는 방법은?
  • 제목만으로 내용을 즉시 이해하기 어렵습니다.
  • "이 문서가 무엇을 말하려는 걸까?"라고 추측해야 합니다.

Do

# `NOT_FOUND_USER` 에러를 해결하는 방법
  • 제목 자체만으로 문서의 목적을 명확하게 전달하고 있습니다.

✅ 일관성을 유지하세요

문서 전체에서 제목의 스타일을 일관되게 유지하세요. 같은 수준의 소제목은 동일한 문체와 표현 방식을 따라야 합니다. 제목을 동사형 또는 명사형으로 통일하세요.

단계가 있다면 숫자를 사용하세요. 단계별 절차를 다루는 문서라면, 제목에 숫자를 포함하면 이해하기 쉽습니다.

Don't

# 제목을 쓰는 방법 ## 키워드를 포함하세요 ## 일관성 유지 ## 평서문으로 작성하기
  • 소제목 스타일에 일관성이 없어요.

Do

# 제목을 쓰는 방법 ## 키워드 포함하기 ## 일관성 유지하기 ## 평서문으로 작성하기
  • 일관된 '~하기' 제목을 사용했어요.

✅ 제목은 30자 이내로 간결하게 쓰세요

중복되거나 불필요한 단어를 줄이고, 핵심 정보만 남겨서 가독성을 높여요.

✅ 제목은 평서문으로 작성하세요

느낌표(!)나 물음표(?) 대신 평서문을 사용하세요. 느낌표나 물음표는 감정을 강조하거나 독자의 관심을 끄는 역할을 할 수 있지만, 기술 문서에서는 문서의 주제와 목적을 빠르게 이해하는 것이 더 중요합니다.