#정보 구조 만들기

문서를 작성하는 사람이 알고 있어야 할 가장 기본이 되는 원칙과 문서 구조를 짜는 방법, 그리고 각 구조를 어떻게 효과적으로 작성할 수 있을지 소개할게요.

가장 중요한 건 문서를 읽는 사람 입장에서 설계하는 거예요. 기술 문서는 주로 문제 해결, 학습, 참조 목적으로 사용되기 때문에 독자가 어떤 목표를 가지고 문서를 찾았을지 고려하면서 작성해야 해요.

#주요 원칙

#한 페이지에서 하나만 다루기

• 제목 깊이가 #### (H4) 이상이 되면 문서를 나누는 것을 고려하세요.
• 개요를 다루는 페이지를 활용해 보세요.
• 최대한 구체적인 주제를 다루세요.

#가치를 먼저 제공하기

• 부가적인 정보나 세부 사항은 나중에 배치하세요.
• 기능 중심 설명을 피하고, 독자가 얻을 가치를 먼저 전달하세요.

#효과적인 제목 쓰기

• 제목에는 핵심 키워드를 포함하세요.
• 일관성을 유지하세요.
• 제목은 30자 이내로 간결하게 쓰세요.
• 제목은 평서문으로 작성하세요.

#개요 빠트리지 않기

• 개요는 문서의 핵심 내용을 요약해야 합니다.
• 문서의 목표를 독자에게 명확히 전달하세요.
• 기술적 배경 설명보다는 핵심 정보를 먼저 제공하세요.

#예측 가능하게 하기

• 일관된 제목, 형식, 구조를 유지하세요.
• 섹션 제목은 동일한 패턴을 따르세요.
• 논리적인 순서로 정보를 배치하세요.
• 용어를 일관되게 사용하세요.