1. 개요

가. 문서 목적

해당 문서는 문서를 어떻게 하면 읽는 사람이 편하게 통일된 형식으로 작성할 수 있을까에 대해서 작성하였고 추후 문서를 작성하는 나자신의 참고자료로써도 사용될 예정이다.

나. 목차

1) 문서화 형식
2) 문서화를 잘하면 작성자에게 좋은 점

2. 문서화 형식

가. 개요를 통해 읽는 사람이 문서 전체 내용을 알게하라

두괄식으로 쓰라는 것이다.

당신이 흥미진진한 글을 쓰는 작가가 아닌이상, 끝에 결과가 오는 미괄식으로 쓸 필요는 없지 않은가. 해당 문서에도 나와있듯이 모든 문서에는 개요라는 첫번째 단락을 통해서 읽는 사람이 해당 문서의 순서를 한눈에 파악할 수 있게 해야한다. 이 방식을 통해 읽는 사람은 이 문서를 두번 읽는 듯한 마치 알고 있는 것을 읽게만드는 효과를 느낄 수 있다.

나. 사람들은 크고 두꺼운 글자부터 읽는다.

이게 눈이 먼저 갈껄?

이거보다

다. 항목번호는 통일

필자는 1. -> 가 -> 1)을 사용하고 있다. 이 방식은 널리쓰이는 방식으로 독자가 읽기 훨씬 수월하게 한다.

라. -보단 표를 사용해라

노션이 유행한 나머지 많은 사람들이 아래와 같이 쓴다.

• 아침에 일어나서
• 밥을 먹었고
• 설거지를 했다

순서	내용
1	아침에 일어나서
2	밥을 먹었고
3	설거지를 했다

뭐가 더 낫나요?

📌 해당 문서는 2026년 02월 09일에 업데이트 되었습니다.