개요 빠트리지 않기

개요는 문서의 핵심 내용을 요약하고, 독자가 문서를 읽기 전에 내용을 빠르게 이해할 수 있도록 돕습니다. 명확한 개요는 독자가 문서를 끝까지 읽을지 결정하는 중요한 요소이며, 문서의 흐름을 효과적으로 전달하는 역할을 합니다.

1. 독자가 문서의 내용을 빠르게 파악할 수 있습니다

적절한 개요는 독자가 문서의 핵심 내용을 파악하고, 필요한 정보를 찾는 시간을 줄여줍니다. 문서의 개요를 읽는 것만으로 문서가 다루는 주제와 목적을 이해할 수 있어야 합니다.

2. 검색 결과에서 문서의 가치를 효과적으로 전달할 수 있습니다

검색 엔진이나 문서 시스템에서 개요는 검색 결과의 일부로 표시될 때가 많습니다. 개요가 잘 작성된 문서는 검색 결과에서 더 많은 클릭을 유도할 수 있습니다.

3. 문서의 흐름을 정리하고, 작성 과정에서 핵심 내용을 유지할 수 있습니다

개요를 먼저 작성하면, 문서의 주요 논점을 정리하고 불필요한 내용을 줄여서 문서의 초점을 유지하는 데 도움이 됩니다.

체크리스트

✅ 개요는 문서의 핵심 내용을 요약해야 합니다

문서 전체를 읽지 않아도, 개요만으로 문서의 주제를 파악할 수 있어야 해요. 개요는 제목 바로 아래, 본문이 시작되기 전에 배치하세요.

✅ 문서의 목표를 독자에게 명확히 전달하세요

"이 문서를 읽으면 무엇을 할 수 있는가?"에 대한 답을 개요에서 제공하세요.

Don't

TypeScript의 유틸리티 타입

이 문서는 TypeScript의 유틸리티 타입을 소개합니다. Partial, Pick, Omit 등의 유틸리티 타입을 사용할 수 있어요.

  • "왜 유틸리티 타입을 사용해야 하는지"에 대한 설명이 부족합니다.

Do

TypeScript의 유틸리티 타입

TypeScript의 유틸리티 타입을 사용해서 객체 타입을 변형하는 방법을 알아볼게요.

유틸리티 타입을 활용하면 반복적인 타입 선언을 줄이고, 더 유연하게 타입을 관리할 수 있어요. 이 문서에서는 Partial, Pick, Omit 등을 사용하여 객체 타입을 효과적으로 다루는 방법을 알아볼게요.

  • 독자가 문서를 통해 배울 수 있는 내용을 명확하게 설명하고 있습니다.

✅ 기술적 배경 설명보다는 핵심 정보를 먼저 제공하세요

기능에 대한 상세한 설명을 바로 넣기 보다는, 독자가 해당 기능으로 얻을 수 있는 직접적인 가치를 먼저 알려주세요.

Don't

React 상태 관리

React에서 상태 관리란 무엇일까요? React는 컴포넌트 기반 UI 라이브러리로, 상태(state)를 관리하는 것이 중요합니다. 상태 관리는 여러 방식으로 구현할 수 있으며, 다양한 라이브러리도 존재합니다. 이 문서에서는 상태 관리의 개념과 몇 가지 방법을 소개합니다.

  • 개요가 너무 길고 설명이 추상적이라서 핵심 내용을 파악하기 어렵습니다.

Do

React 상태 관리

이 문서는 React에서 상태(state) 관리의 개념과 주요 기법을 설명합니다.

useState, useReducer, Context API, Redux 등의 방법을 비교하고, 각 방식의 장점과 단점을 이해할 수 있도록 안내합니다.

  • 개요만 읽어도 문서의 핵심 내용을 쉽게 파악할 수 있습니다.