Google Developers에서 진행하는 Free technical writing courses-2

Google Developers에서 진행하는 Free technical writing courses를 듣고 정리한 글입니다. 
이전 글은 이곳에서 확인할 수 있습니다. 이전 글에서는 토론에 대해서 정리해보았고, 이 글에서는 강의에서 진행한 실습 중 중요한 내용에 대해서 정리해보려고 합니다. 

---

Excerise 2

예시 문장을 재배열, 추가, 삭제 또는 단어를 수정해서 문장을 적절하게 개선시키는 실습을 진행했다. 정해진 정답은 없지만 강의에서 말한 내용들을 바탕으로 수정해보려고 한다. 

1. The moth was removed by Grace Hopper.

첫 번째 문장은 수동태로 작성되었다. 직역을 해보자면 나방은 Grace Hopper에 의해 제거되었다.라고 번역할 수 있다. 수동태와 능동태 관련해서 공부한 포스트가 있는데 해당 포스트에서 왜 수동형을 능동형으로 바꾸는 것이 좋은지 알 수 있다. 

이 문장을 능동형으로 고쳐보면 Grace Hopper removed the moth. 로 바꿀 수 있다. 사실 능동형으로 고치는 게 정답인가?라고 하면 꼭 그렇지만은 않다고 생각한다. 작성된 글이 만약 Grace Hopper에 대한 글이라면 능동형으로 바꿔 Grace Hopper라는 인물이 앞에 와서 이해하기 더 쉬운 문장이 되지만 The moth(나방)이 주제가 되는 글이라면 나방을 주어로 두는 것도 괜찮지 않을까?라는 생각이 든다. 

 

2. Performance optimization is overriden by the --noperf flag.

우선 나는 이 문장을 The --noperf flag overrides performance optimization이라고 작성해봤다. 1의 예시처럼 수동을 능동형으로 바꾸었다. 하지만 여기에서 고려하지 못한 점은 여기 overriden(중지하다,우선하다,재정의하다)라는 단어를 보다 쉬운 단어로 바꾸지 못했다는 것이었다. overriden이라는 단어보다 turn off를 사용하게 되면 보다 명확하게 보인다. 나조차도 익숙하지 않은 단어인 overriden을 보고 이게 무슨 단어더라?라고 생각하게 되었다. turn off로 단어를 바꾸면 --noperf플래그가 성능 최적화를 해제하는구나라고 바로 파악할 수 있었다. 

또 다른 모범 답안으로는 To turn off performance optimization, specify the --nopeft flag. 등이 나왔다. 이 문장도 기존 문장보다 훨씬 명확해졌다. ~하기 위해서는, ~해라.라고 직접적으로 작성했기 때문에 영어가 익숙하지 않은 나에게도 기존 문장보다 무슨 뜻인지 한 번에 이해하기가 쉬웠다. 

 

3. The measurements were taken by the static Timer() method until it was discovered by the QA team that bugs were present in the Timer() method.

세 번째 문장은 이렇게 고쳐보았다. The static Timer() method took the measurements until the QA team discovered the bugs in the Timer() method. 여기도 역시 수동태로 된 문장을 능동태로 바꾸니 읽기 쉬워진다.

여기에서 모범답안은 Our team took measurement with the static Timer() method until the QA team found bugs in the Timer() method it self. 로 작성되었다. 내가 작성한 문장이랑 차이점은 뭘까 생각해봤다. 모두 능동형으로 바꿔준 것은 같지만 Our team이 측정했다고 행위를 한 대상이 누군지 명시해주었고, discoverd라는 단어를 found라고 직관적으로 단어를 바꿔주었다.

 

 

Excerise 3

세 번째 실습은 칫솔과 치약을 한 번도 본 적이 없는 Jane과 David에게 묘사를 해주는 작업이었다. 단, 이를 닦는 방법에 대해서 설명하지는 말아야 한다.

처음에는 이런 간단한 작업을?이라는 생각이 들었지만 막상 흔히 볼 수 있는 칫솔과 치약을 설명하는 것은 많은 것을 고려해야 했다. 여기에서 주의할 점은 너무 생략해서도 안되고 지나치게 과도한 정보를 주지 않는 것이었다. 번호 매기기 목록 형태, 글머리 기호 형태, 줄글 등으로 많은 사람들이 다양한 방법으로 설명했다.

가장 인상 깊었던 예시는 자주 사용하는 손까지 고려해서 설명한 점이었다. With your dominant hand, remove the cap from the toothpaste tube by turning cap counterclockwise.라는 문장이었는데 자주 사용하는 손을 사용해서 치약의 뚜껑을 시계 반대방향으로 돌린다~라고 아주 구체적으로 명시해주었다. 

이 예제를 실습하면서 SOP를 작성할 때 아무것도 모르는 사람이 현장에 가서 작업을 할 수 있도록 구체적이고, 명확하게 작성해야 함을 다시 한번 생각해보았다. 

 

 

Exersise 4

Exerise2와 마찬가지로 제시된 문장을 rewrite 해보는 작업이다. 단, 여기에서는 주니어 개발자를 대상으로 설명한다고 생각하고 문장의 길이를 줄여 핵심만 작성해보는 실습이다. 

1. JavaScript, despite the similarity in name to Java, has nothing to do with Java and has more to do with marketing, meaning that the inventors of JavaScript wanted to capitalize on the popularity of the earlier language. 

자바스크립트의 이름은 자바와 비슷하지만 자바와는 아무런 관련이 없고 마케팅과 더 관련이 있는데, 자바스크립트의 발명가들이 초기 언어의 인기를 이용하기를 원했다는 것을 의미한다. (직역)

이 문장을 핵심만 간단하게 요약하자면 자바스크립트는 자바와 연관이 없다. 가 된다. 이 문장은 누군가 보기에 너무 많이 요약을 했다고 느낄 수도 있다. 뒤에 덧붙인다면 자바스크립트 창시자는 자바의 인기에 편승하기 위해 자바스크립트라는 이름을 선택했다. 를 추가할 수 있다. 

Java Script and Java are unrelated. JavaScript's creators chose the name to capitalize on Java's popularity

3. Python, which was invented by Guido van Rossum from the Netherlands in 1991, is a language whose primary data type is the list (like Lisp) and that emphasizes readability based on indentation (like FORTRAN).

1991년 네덜란드 출생인 Guido van Rossum에 의해 개발된 파이썬은 Lips와 같은 주요 데이터 유형이 리스트이며 FORTRAN과 같은 들여 쓰기를 기반으로 가독성을 강조하는 언어이다. (직역)

이 문장에서는 발표자가 제시한 모범답안의 첫 문장 주어가 Guido van Rossum으로 되어있었는데 한 참가자가 파이썬에 대한 문장이므로 파이썬이 주어로 오는 게 적절하지 않냐는 의견이 나왔다. 예를 들어 이렇게 작성할 수 있다. 

Python is a programming language invented by Guido van Rossum-Netherlands in 1991.

많은 사람들이 이 의견에도 동의했고 나도 이 문장이 더 좋다고 생각한다. 왜냐하면 뒤에 나오는 설명이 개발자인 사람에 대한 문장이 아니라 파이썬이 어떤 언어인지를 설명하는 문장이기 때문이다. 뒤에 문장들도 목록 형태로 정리할 수 있다.

 파이썬은 1991년도 네덜란드 출생인 Guido van Rossum에 의해 개발되었다. 파이썬은 다음과 같은 특징을 가진다.
  - 주요 데이터 타입은 리스트이다.
  - 들여 쓰기로 가독성을 높인다. 

 

 

Exercise 5

여기에서는 문단을 정리하는 실습을 해보았다. 막 학교를 졸업하고 엔지니어링 팀에 합류한 Li and Arash를 위해서 dogfooding이라는 용어에 대해서 설명을 해줘야 하고 아래 문장을 수정하는 실습이다. 

여기서 dogfooding이란? 조직이 제품이나 서비스를 사용해보고 실제 사용 환경에서 제품을 테스트하는 방법을 의미한다. 영어로 되어있어서 한글로도 번역해보았다. 

There are several intended primary goals for dogfooding a new project. At the current time, it is suggested by Engineering that all projects be in dogfood for a period of no less than one month. One is to find bugs under heavy, high-cycle usage. When disastrous bugs occurred in 153 out of 157 of the previous project releases, Engineering's analysis of bugs in the aftermath concluded that prevention of the bugs could have happened by more thorough testing.

새 프로젝트를 도그 푸딩(dogfooding) 하기 위한 몇 가지 주요한 목표가 있습니다. 오늘날에 엔지니어링은 모든 프로젝트가 최소 한 달 동안 도그 푸드에 있을 것을 제안합니다. 그중 하나는 과도하고 높은 사이클의 사용하여 버그를 찾는 것입니다. 이전 프로젝트 릴리즈 157개 중 153개에서 치명적인 버그가 발생했을 때, 여파에 대한 엔지니어링의 버그 분석은 더 철저한 테스트를 통해 버그를 예방할 수 있었습니다.

사실 위에 번역문이 잘 번역되었다고는 말할 수는 없다.😂 

위 문장에서 내가 생각하는 고쳐야할 점은

1. 도그 푸딩(dogfooding)에 대한 정의가 문단의 맨 앞에 와야 한다고 생각한다.
2. 문장 구성을 정리하고 앞서 배워봤던 모호한 동사들을 수정할 필요가 있다. 

실습 중 간단하게 고쳐본 문장은 아래와 같다. 아직 영어로 술술 문장을 작성해볼 능력이 되지 않아서 한글로 작성해봤다. 

도그 푸딩(dogfooding)은 직접 제품이나 서비스를 사용해보고 실제 사용 환경에서 테스트하는 방법을 의미합니다. 이 과정은 과도하고 높은 사이클의 테스트에서 버그를 찾는데 도움을 줍니다. 엔지니어링은 적어도 한 달 동안 도그 푸딩 하는 것을 권장합니다. 엔지니어링은 철저한 테스트 과정으로 이전 제품 릴리즈의 97%에서 치명적인 버그를 예방할 수 있음을 발견했습니다. 

정답은 없지만 이제보니 고칠 부분이 많이 보인다. 이 실습을 통해 다른 사람들의 의견도 볼 수 있었고 '이렇게도 작성해볼 수 있구나'라는 생각을 많이 했다. 해당 과정이 영어로 진행돼서 알아들을 수 있을까? 했지만 정리하면서 되짚어보니 참가하길 잘했다는 생각이 든다! 다음 과정도 이어서 참가할 예정이다. 

---