글쓰는 방법

기술 문서 작성 5단계

글쓰는 방법​

1. 목차 작성

• 구체적이고 제목만 봐도 "어떻게"해야 하는 지 전달
• 목차의 순서를 난이도/복잡도가 낮음 => 높음으로 정렬

2. 세부 목차를 작성한다.

• 주장을 담은 세부 목차를 정의한다. ​

3. 내용을 작성한다.

• 작성 구조
  • 서론(주장, 근거), 정보-사례, 정리
  • 개요 배경 주장 근거 사례 순서로 작성한다.
  • 기승전결[1]로 작성한다.
• [블로그] 이렇게 해야한다 보다 나는 이렇게 한다로 정의
• 각 단락의 주장에 맞게 작성
• 각 문장을 주장에 맞게 작성
• 자료가 읽는 사람에게 정보가 되게 정리
• 추상적인 화두 뒤에 "어떻게" 해야하는 지 구체적인 설명 필요
• 어려운 설명앞에는 비유적이고 일반적인 쉬운 내용을 추가한다.
• 용어에 링크
• 어조를 통일한다.
  • 주장에 대한 글은 주장만
  • 사례에 대한 글은 사례만

두괄식보다 미괄식

경우에 따라 다르겠지만 부드럽게 표현하고 싶다면 미괄식으로 표현하는 게 자연스럽게 느껴짐 ​

4. 구체적인 그림이나 예제 추가

• 그림과 예제도 설명을 추가한다.

5. 글에 책임과 무게를 부여한다.

• 많은 사람들 앞에서 전달할만한 깊고, 생각이 아닌 지식을 이야기한다. ​

[1] 기승전결

서론

• 본론에 들어가기 전에 하는 말, introduction
• 문제제기를 통해 논의의 방향과 범위를 구체적으로 설정하는 단계
• 시작 방법은 다양하다

- 주제에 대한 정의로 시작
- 주제를 바로 제시
- 인용 또는 비유로 시작

설명

• 어떤 일이나 대상의 내용을 상대편이 잘 알 수 있도록 밝혀 말함.

증명

• 어떤 사실을 증거를 대어 틀림없다고 밝힘
• 주어진 문제의 주장에 대한 근거를 제기하는 과정

- 비교 논술
- 원인 대책

결론

• 끝을 맺는 부분, 최종적으로 판단을 내림 또는 그 판단 ​- 요약형: 지금까지 쓴 글을 간결하고 쉽게 요약해서 다시 한 번 주장
• 제안형: 주장에 대한 해결 방법이나 개선안을 제시
• 전망형: 앞으로 어떻게 변화될 것인지, 자신의 의견을 뒷밭침 할 수 있는 전망을 제시