1단계: 계획하기 - 아웃라인 작성하기

지금까지 기술문서의 계획단계 중 4가지를 알아보았습니다. 먼저 기술 문서에 작성할 주제를 정하고, 기술문서를 읽을 특정 독자를 분석한 뒤, 기술 문서의 작성 목적을 분석합니다. 그리고 기술 문서의 종류를 선정하게 됩니다.

 

그렇다면 오늘 알아볼 1단계의 계획단계에서 더 나아가서 아웃라인의 목차를 작성하는 방법에 대해 알아봅시다. Formal Report의 아웃라인의 작성은 다음과 같습니다. 

---

서두 (Front Matter)

• Title Page (필수)
• Revision History
• Abstract (요약, 독자가 내 글을 읽을지 말지를 결정할 수 있는 브리프)
• Table of Contents (필수)
• List of Figures, List of Tables
• Preface
• Abbreviations and Definition

본문 (Body)

• Executive Summary
• Introduction
• Text - Detailed procedures, methods, results, and how the results are obtained
• Conclusions
• Recommendations

말미 (Back Matter)

• Appendixes
• Bibliography
• Glossary
• Index
• Legal Information

 

---

 

여기서 Formal Report와 Informal Report의 차이점을 알아보자면, 나와 독자와의 관계가 얼마나 멀고 가까운지를 판별하는 것입니다. 만약 독자가 작성자와의 관계가 가깝다면, 좀 더 쉬운 단어를 사용하고, "You"라는 지칭을 사용할 수도 있습니다. 하지만 독자와의 관계가 비즈니스 관계와 같이 먼 사이라면 Formal Report 형식을 사용하여야 합니다.

그렇다면 Informal Report에 대해서도 알아봅시다. 위의 Formal Report와 다른 점은 몇 가지 항목을 삭제해도 무방하다는 것입니다. 아래의 리스트에서 볼 수 있듯이 Abstract와 Executive Summary, Conclusions, Bibliography, Glossary 등은 필수 항목이 아니므로 Informal Report에서는 간략하게 작성이 가능합니다.

 

서두 (Front Matter)

• Title Page (필수)
• Revision History
• Abstract (요약, 독자가 내 글을 읽을지 말지를 결정할 수 있는 브리프)
• Table of Contents (필수)
• List of Figures, List of Tables
• Preface
• Abbreviations and Definition

본문 (Body)

• Executive Summary
• Introduction
• Text - Detailed procedures, methods, results, and how the results are obtained
• Conclusions
• Recommendations

말미 (Back Matter)

• Appendixes
• Bibliography
• Glossary
• Index
• Legal Information

1단계 계획에서 이 아웃라인을 작성하는 이유는 초안을 작성하기 전에 아이디어를 구성하기 위한 가장 일반적이고 효과적인 방법이기 때문입니다. 기술문서 작성자에게는 지금 내가 어디에 있는지 알 게 지도에서 내비게이션 역할을 해준다고 생각하면 좋을 것입니다. 기술 문서를 각각의 주제로 분리함으로써 각각의 주제들을 어떻게 구성해야 할 지에 관해서도 결정할 수 있게 됩니다. 아웃라인은 3수준까지만 구성하도록 하는데, 3수준이라는 것은 대제목, 중제목, 소제목을 말하는 것입니다.

좋은 구성을 만들기 위한 가이드라인을 알아보자면, 먼저 구성의 개념에 대해 알아보아야 합니다.
구성은 기술 문서를 읽는 특정 독자가 필요한 내용을 쉽고 빠르게 찾고, 그 내용을 이해하기 쉽도록 각각의 정보들이 논리적으로 연결된 것을 의미하는 것입니다. 구성은 두 개 이상의 주제들을 논리적으로 배열할 수 있으며, 각 주제 안에 있는 정보들을 논리적으로 배열할 수 있습니다. 예를 들면, 주제 안에 단락, 리스트, 표, 그리고 이미지를 논리적으로 구성하는 것을 들 수 있습니다. 구성은 기술 문서를 작성하는 데 있어서 가장 중요하다고 볼 수 있습니다. 구성은 특정 독자가 목차를 통해 필요로 하는 정보를 쉽게 찾을 수 있도록 하며, 기술 문서 작성자가 정보를 효율적으로 관리할 수 있도록 하기 때문에 기술 문서의 뼈대를 만드는 가장 기초적이며 중요한 단계라고 볼 수 있습니다.