1-7. Paragraphs
Google Technical Writing Course - 1
단락에 대한 이야기.
목차는 아래와 같다.
Write a great opening sentence
첫 문장에 단락의 주제 담기.
Technical Writing 뿐만 아니라, 어느 글쓰기 책이나 수업에서도 강조하는 내용.
하지만 막상 그렇게 쓰거나 고치려고 하면 쉽지만은 않아서, 연습이 많이 필요한 부분.
그런 이유로, 바로 Exercise로 넘어간다.
Exercise
The Pythagorean Theorem states that the sum of the squares of both legs of a right triangle is equal to the square of the hypotenuse. The k-means clustering algorithm relies on the Pythagorean Theorem to measure distances. By contrast, the k-median clustering algorithm relies on the Manhattan Distance.
첫 문장을 제대로 쓰지 못한 장황한 문단이다. 그래서 한 눈에 내용을 파악하기가 어렵다.
아래와 같은 첫 문장을 사용함으로서 이 문단의 주제와, 후속 내용을 훨씬 쉽게 받아들일 수 있다.
→ Different clustering algorithms measure distances differently.
참고로, 임팩트 있는 첫 문장을 작성하기 위해 인용 등 다양한 Hook을 사용할 수 있다는 점도 기억해두기.
그런데 기술 문서에서도 Hook을 많이 사용하나...?
Focus each paragraph on a single topic
+ Don't make paragraphs too long or too short
하나의 단락에 한 가지 내용만 포함할 것.
그리고 문단을 너무 길거나 짧게 하지 말 것.
여기도 너무 당연한 내용이라 넘어간다.
Answer what, why, and how
좋은 문단은 아래의 what, why, how에 대해 모두 답할 수 있는 문단이다.
1. What are you trying to tell your reader?
→ 즉 문단의 주제. 앞서 얘기된대로 문단 처음에 제시되어야 하는 것.
2. Why is it important for the reader to know this?
→ 독자가 이걸 왜 알아야 하는데? 라는, 가장 매서운 부분. 문단 혹은 글 자체의 존재 여부를 결정짓는다.
3. How should the reader use this knowledge? Alternatively, how should the reader know your point to be true?
→ 독자에게 얼마나 유용한 정보인지, 실질적으로 어떤 의미를 가지는지에 대한 답을 담고 있어야 한다.
아래는 what, why, how에 대한 답을 모두 담고 있는 문단에 대한 예시이다.
<What> The garp() function returns the delta between a dataset's mean and median. <Why>Many people believe unquestioningly that a mean always holds the truth. However, a mean is easily influenced by a few very large or very small data points. <How>Call garp() to help determine whether a few very large or very small data points are influencing the mean too much. A relatively small garp() value suggests that the mean is more meaningful than when the garp() value is relatively high.
출처 : https://developers.google.com/tech-writing/one/paragraphs
