제 3장. 순서와 계층

1. 순서는 글을 배열하는 것

독자가 글을 읽기 쉬운 순서로 나열한다.

 

작업 순서로 글을 나열할 때

번호를 추가하면 순서가 더 명확해진다.

번호 뿐만 아니라 글의 형식또한 통일한다.

 

아는 것에서 모르는 것으로

1. 독자가 이미 알고 있는 것을 간결하게 쓴다.
2. 알고 있는 것과 모르는 것이 섞인 내용을 쓴다.
3. 모르는 것에 대해 자세히 쓴다.

 

2번의 알고 있는 것과 모르는 것이 섞인 내용을 쓸 때에는 예시를 제시하거나, 질문은 던져본다.

 

구체에서 추상으로

구체적인(특수한) 예시를 먼저 제시하고, 추상적인(일반적인) 경우를 설명한다.

또한 구체적으로 설명한 문단과 추상적인 문단은 병렬적인 형식을 취한다. (병렬법 참고)

특수 로그인 화면의 테스트 코드를 작성할 때 가장 먼저 화면의 입력란이 렌더링되었는지 확인하는 코드를 작성한다.
일반 어떤 화면의 테스트 코드를 작성할 때, 화면의 주요 요소가 렌더링되었는가를 확인하는 코드를 가장 먼저 작성한다.

 

번외 ) 추상에서 구체로

추상적으로 기술한 내용에 대한 구체적인 예시를 제시하는 경우

 

용어의 정의

글에서  새로 도입되는 용어는 명확하게 정의하고 사용한다.

 

정의하는 방법

1. '용어의 정의' 절을 따로 분리하여 용어들의 정의를 분리한다.
2. 용어를 사용하기 직전에 정의한다.
3. 용어를 사용하기 직전에는 잠정적으로 정의하고 부록에서 자세히 정의한다.

 

 

2. 계층은 글을 통일하는 것

계층: 독자가 기대한 곳에 기대한 내용이 있게 글을 구성한다.

 

계층을 생성하는 방법

1. 글을 작은 단위로 분해한다.
2. 누락된 요소는 보완하고, 겹치는 요소는 제거한다.
3. 동일한 수준의 요소를 모아서 그룹을 생성한다.
4. 계층별로 순서를 정돈한다.

 

3. 순서와 계층을 읽기 쉽게 표현하는 방법

개조식

순서가 있을 경우, 번호를 단다.

순서가 있는 개조식은 보기에 불편하지 않게 주의한다.

 

열거

항목의 총 개수를 미리 쓴다.

여기서 아래 4개의 경우를 생각해보자.
1. 2. 3. 4. ...

동일한 내용을 다른 방식으로 여러 번 설명하면 독자가 제대로 알고 있는지 확인하면서 글을 읽을 수 있다.

들여쓰기

인용을 명확하게 표현하기 위해 인용된 문장은 들여쓰기한다.

 

병렬법

내용적으로 대비되는 것을 형식적으로 대비시키는 것