[Technical writing] Ch2. Structure: Organizing your documents.

Chapter 2. Structure: Organizing your documents.

If a man can group his ideas, then he is a writer. - Robert Louis Stevenson.

  An organization, which has a beginning, middle, and ending, is a basic format structure for general scientific documents, such as reports and articles. The beginning of a report or article serves a specific purpose: defining the work, showing why the work was done, giving background for understanding the work, and revealing how the work will be presented. The middle states what happened in the work, how it happened, what is the result, and what the result means. The ending analyzes the work and gives a future perspective.
  The beginning of a scientific document includes the title, summary, and introduction. The title is the single most important phrase of a scientific document. It identifies the field of study and separates the document from all other documents in that field. In a strong title, you give enough information to orient, but not too much information to confuse readers. When the purpose of writing is to inform, you could write a descriptive summary or informative summary. The descriptive summary tells what kind of information will occur in the document. The informative summary tells what results occurred in the work. In writing introduction, by the end of introduction, audiences expect answers to the following questions: what exactly is the work? Why is the work important? What is needed to understand the work? How will the work be presented?
  The middle or discussion of a scientific document simply presents the work. In writing the middle, you select a strategy that is appropriate for your audience, and then you reveal that strategy through your headings and subheadings.
  The ending of document provides closure. Readers expect an analysis of the most important results from the document’s discussion and a future perspective on the work. In addition, you supply back matter in the form of appendices and glossaries for your secondary audiences.

  시작, 중간, 끝으로 글을 구성하는 것은 일반적이면서 가장 좋은 방법이다. 시작부분은 수행한 작업을 정의하고, 왜 그 작업이 수행되었는지 이유를 밝히고, 그 작업을 이해하는 배경지식을 제공하고, 마지막으로 그 작업을 어떻게 설명할지를 드러내야 한다. 또한 중간부분은 작업에서 무엇이 어떻게 벌어졌는지를 설명해야 한다. 마지막으로 끝부분은 작업의 결과를 분석하고, 미래에 대한 전망을 제시해야 한다.
  시작부분은 제목, 요약, 도입부를 포함한다. 제목은 전체 문서에서 가장 중요한 한 문장을 사용하는 것이 좋다. 그 문장은 연구 분야가 어디인지 알려주어야 하고, 반대로 같은 연구 분야의 다른 많은 글들과 차별성을 나타내야 한다. 좋은 제목이란 충분히 정보를 전달하고 있어야 한다. 그러나 지나친 정보의 전달은 읽는 사람에게 혼동을 줄 수 있다는 것을 알아 두자. 글의 목적이 정보를 전달하는 것이라면, 묘사적 요약이나 정보 전달적 요약을 사용해야 한다. 묘사적 요약의 경우 앞으로 문서에서 어떤 정보들이 이야기 될지 알려준다. 반면, 정보 전달적 요약의 경우, 작업의 결과가 무엇이 될지를 알려준다. 도입부는 그 부분을 다 읽었을 때, 정확히 그 작업이 무엇이고, 왜 중요하고, 작업을 이해하기 위해 무엇이 필요한지, 또 작업이 어떻게 설명될 것인지를 알도록 작성되어야 한다.
  중간부분은 간단하게 말해서 작업을 설명한다. 이 부분에서 읽는 사람을 고려해서 적절한 전략을 사용해야 하고, 이 전략은 소제목이나 문단의 제목을 통해서 명확히 드러나도록 해야 한다.
  끝부분에서 읽는 사람은 중간부분에서 다룬 작업의 가장 중요한 결과의 분석과, 그 작업과 관련된 미래의 전망이 담겨 있기를 기대한다. 또한 부차적인 독자를 위한 참고 자료를 안내해주기를 바란다.
  각 부분이 위에서 설명한 역할을 잘 하도록 글을 작성한다면 기본적인 구조이지만 아주 훌륭한 문서를 작성할 수 있을 것이다.