[Technical writing] Ch1. Introduction : Deciding where to begin.

Chapter 1. Introduction : Deciding where to begin.

But in science the credit goes to the man who convinces the world, not to the man to whom the idea first occurs. - Sir Francis Darwin.

  The reasons why scientific writing is difficult are considered in two ways. The first reason is the inherent complexity of the subject matter. The second reason is the inherent complexity of the language. There is no simplistic advice for scientific writing, but just its constraints are there: the audience for the document, the format, the mechanics and the politics.
  “efficiency” is the keyword in tailoring your writing to the audience. When the purpose of the writing is to inform, you should try to communicate the most amount of information in the least amount of reading time. When the purpose of the writing is to persuade, you should try to present logical arguments in the most convincing manner.
  You should assess the audience: who will read the document, what do the know about the subject, why will they read the document, and how will they read it. The questions teach you what background information to include, which terms to define, and which results to emphasize. And you should also think about format, mechanics, and politics. Format is the way the type is arranged on the page. Mechanics encompasses the rules of grammar and punctuation. Politics is most difficult to discuss. Staying honest is straightforward enough.
  Style comprises three elements: structure, language, and illustration. Structure is the strategy of a scientific document. Language is the way that words are used. Illustration is the meshing of figures and tables with the language.

  기술적인 내용의 문서 작성은 주제 자체의 어려움과 다루는 언어 자체의 어려움 때문에 상당히 어려운 작업이 된다. 기술 문서의 작성에서는 문서의 독자, 페이지의 형식, 문법이나 구두점의 사용법, 정치적 요소들이 고려되어야 한다. 이중에서 독자에 대한 고려가 제일 중요한 것 같고 다음과 같은 질문에 답을 할 수 있어야 한다: 누가 이 문서를 읽을 것인가? 주제와 관련하여 무엇을 알고 있는가? 문서는 왜 읽고 어떻게 읽을 것인가? 이 질문들은 기술 문서에서 어느 정도의 배경지식이 담겨야 하고, 어떤 용어들을 정의하여 사용하여야 하는지 알려준다. 또 문서 작성에서 스타일은 세 가지 요소로 나뉘어 진다. 문장의 구조, 사용하는 문장, 그림이나 표의 배치. 위 고려 요소를 잘 생각해서 바람직한 스타일로 글을 작성하는 것이 기술적인 문서를 효과적으로 작성하는 방법이 될 것이다.