1-11. In-class

Google Technical Writing Course - 1

Jun 21. 2025

proximity to the knowledge

In-class는 라이브로 진행되는 실습으로,

실제로는 제시된 문제에 대해 각각의 생각을 나누는 자리라고 한다.

아쉽게도 지금은 라이브 세션이 끝나서 그 기회가 없지만, 나중에라도 혹시 라이브에 참여할 경우에 대비해서, 그리고 무엇보다 나중에 다시 봤을 때 어떻게 생각이 바뀌어 있을지 궁금해서 혼자 진행한 내용들이라도 기록해둔다.

+) 챗GPT한테도 물어봤다. 그 답변도 같이 남겨둔다.

1. Which terms do different audiences know?

3개 부류의 타겟 독자층이 제시된 단어에 대해 얼마나 알고 있는가?

하기 기준에 따라 Know와 Explain으로 나누어본다.

- Know: At least 90% of people in this target audience already know what this term means. Therefore, you can use this term without having to first explain it.

- Explain: At least 10% of people in this target audience do not know what this term means. Therefore, you must avoid this term, explain this term, or link to an explanation.

* 챗GPT 답변도 동일함.

2. Improve these sentences

Improve the following sentences. You may rearrange, add, delete, or modify words as you see fit:

1. The moth was removed by Grace Hopper.

→ Grace Hopper removed the moth.

*챗GPT 답변 동일

수동태보다는 능동태 사용.

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

~~→ The --noperf flag optimizes performance.~~

* 챗GPT : The --noperf flag disables performance optimization.

수동태를 능동태로 바꾸고, override라는 단어를 찾아보니 '보완하다'라는 뜻이다. optimize와 의미가 비슷하고, optimize가 override보다는 명확한 것 같아서 optimizes만 사용하는 것으로 바꿨다.

챗GPT의 답변이 정반대라서 다시 찾아보니, override가 '덮어쓰기하다, 무시하다, 재정의하다'라는 뜻이라고... 즉 performance optimization 기능이 비활성화된다는 뜻이었다.

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 team used the static Timer() method to measure excution times, until QA team discovered the bugs in it.

until을 기준으로 앞뒤로 나눠서 살펴보면

1) 'the measurements'라는 부분이 애매하다. 나부터가 static Timer라는 것이 무엇인지, 정확히 무엇을 측정하는지 몰라서 문장을 수정하기 위해 별도로 찾아봐야 했다. 또한 이 함수가 어느 프로그램 혹은 언어에서 이용되는지도 나와 있지 않은데, 이 부분에 대한 배경 지식이 없어서 우선 무난하게 'the team'이라고 두었다.

2) 'QA팀이 버그를 발견했다'는 내용이라서 최대한 간소화했다. 수동태는 능동태로 바꿨다. present는 굳이 없어도 의미 전달에 무리가 없어서 삭제했다.

* 챗GPT : The static Timer() method was used to take measurements until the QA team discovered it contained bugs.

3. Help Jane and David get toothpaste on their toothbrush

나와 비슷한 나이이며 비슷한 수준의 지식을 가지고 있으나,

오직 한 가지, 치약과 칫솔을 본 적이 없다.

그들이 칫솔에 치약을 바를 수 있도록 가이드하는 문서를 작성해볼 것.

Pre-class의 Documentation 파트에 나온 타겟 독자층 정의 및 문서 개요 구성 템플릿을 가져와봤다.

아래 개요에 따라 작성했고, 자세한 내용은 생략.

[타겟 독자 정의하기]

1. 타겟 독자가 누구인가? → 나와 비슷한 지식 수준을 가지고 있으나, 치약과 칫솔을 본 적이 없음.

2. 타겟 독자의 목적은 무엇인가? → 치약과 칫솔이 무엇인지 알게 되고, 치약을 칫솔에 올리는 행위를 할 수 있게 되는 것.

3. 타겟 독자의 사전 지식은? → 치약과 칫솔에 대한 지식이 전무함. 본 적도 없음.

4. 타겟 독자가 문서를 읽은 후 무엇을 알게 되고 할 수 있게 되는가?

- 칫솔과 치약의 생김새와 용도를 알게 된다.

- 칫솔에 치약을 올릴 수 있게 된다.

[문서 개요]

1. 치약과 칫솔이란.

- 치약과 칫솔의 정의

- 치약과 칫솔의 용도

- 치약과 칫솔의 생김새

2. 치약을 칫솔에 올리는 방법

- 치약을 칫솔에 올리는 순서

- 주의할 점, 팁

4. Improve these sentences

Improve the following sentences. Feel free to rearrange, add, delete, or modify words as you see fit.

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.

→ JavaScript has similar name with Java due for marketing reasons. The inventors of JavaScript wanted to capitalize on the popularity of Java. Therefore, they named the new language "JavaScript" although it's not relevant with Java.

1) 문장이 너무 길어서 끊었다.

2) JavaScript가 Java와 비슷한 이름을 가진건 마케팅적인 요소라는 주제문을 앞으로 가져왔다.

3) has nothing to do with을 is not relevant with로 바꿨는데 딱히 문장이 짧아지진 않네.. 근데 뉘앙스가 더 간결하고 명확한 것 같아 바꿔봤는데, 다른 사람은 어떻게 느끼려나?

* 챗GPT : Despite its name, JavaScript is unrelated to Java. The name was chosen for marketing reasons—to capitalize on Java’s popularity.

2. It is important to keep in mind that the career of Katherine Johnson was able to span both the manual calculation era and the time of computer-based computations.

→ Keep in mind that Katherine Johnson's career could span both the manual calculation (era) and the computer-based computations era.

1) 명령문 뉘앙스는 살리되 It is important to는 굳이 필요하지 않은 듯하여 뺐다. 뺌으로서 오히려 더 강조 효과가 좋아지는 것 같다.

2) the career of이 없어도 Katherine Johnson이 무엇을 할 수 있는지 전달하는데는 무리가 없을 듯하여 생략.

3) was able to는 could로 바꿈.

4) era와 the time of 를 하나의 단어로 통일. 특히 하나는 주 단어가 앞에 오고 하나는 뒤에 와서, 구조상 통일감을 해친다. 다만 앞의 era는 생략하는게 나은지(중복 피하기), 의미의 확실성을 위해 넣어야 하는지 잘 모르겠어서 괄호 처리했다.

+) 처음에 'career'를 빼먹었는데, span이라는 단어를 쓰려면 있어야 한다고 해서 추가함.

* 챗GPT : Katherine Johnson’s career spanned both the manual calculation era and the era of computer-based computations—a rare and remarkable transition worth remembering.

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).

→ Python was invented in 1991 by Guido van Rossum, who is from the Netherlands. It has following features:

- Primary data type of Python is the list.

- Python emphasizes reaability based on indentation.

1) 문장이 길어서 끊었다.

2) in 1991을 앞으로 가져왔는데, Guido가 1991에 태어났다는건지 파이썬이 그 때 발명되었다는 건지가 애매하기 때문이다.

3) 뒷부분은 bulleted list로 바꿔보았는데, embedded list가 더 자연스러울지도...?

4) 괄호는 삭제했다. 비개발자 입장에서, Python은 들어본 적이라도 있지 Lisp와 FORTRAN는 뭔지도 모르겠다. 즉 괄호 안의 내용이 주 내용도 아닌데다가 비교를 통해 글을 이해하는 데도 도움이 되지 않는다.

* 챗GPT : Invented in 1991 by Dutch programmer Guido van Rossum, Python is a language that emphasizes readability through indentation (like FORTRAN) and uses lists as a primary data type (like Lisp).

5. Improve this paragraph for Jun and Arash

Jun and Arash are recent engineering school graduates who have just joined your engineering team. In the past, new engineers on your team have not run sufficient internal tests before releasing new products. New engineers on your team usually don't know what the term dogfooding means.

신생 엔지니어인 Jun과 Arash에게 맞게 문단 고치기.

먼저 위의 설명을 기반으로 Jun과 Arash에 대해 정리하면 아래와 같다.

1. role : new engineers (막 팀에 합류함)

2. proximity to the knowledge :

신제품 출시 전 Internal Test에 대한 경험 없음

dogfooding의 의미를 모름

수정해야 하는 문단은 "dogfooding"의 목적, 즉 신제품 출시 전 내부 검증 테스트의 필요성에 대해 강조하고 있다. 결론부터 말하면 하기 문단에서 "dogfooding"의 의미가 무엇인지만 추가되면, 타겟 독자의 수준 관점에서는 전달력에 무리가 없을 듯하다. internal test에 대한 경험이 전무한 사람들에게 시행 기간, 목적, 중요성 등을 충분히 이해하기 쉽게 다루고 있기 때문이다.

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" indicates pre-test performed by internal team members before release of new products or services. One of the important goals of dogfooding is to fnid bugs under heavy, high-cycle usage. Currently, Engineering suggest to dogfood all projects at least for one month. When disastrous bugs occurred in 153 out of 157 of the previous project releases, Engineering's analysis of bugs in the aftermath concluded that more thorough testing could have prevented the bugs.

처음에 dogfood의 정의를 먼저 내리고 갈지, 문단의 주제인 '목적'을 앞에 둘지 고민했는데, 우선 dogfood가 뭔지 설명하는게 먼저다 싶어서 정의 → 목적 → 설명 순으로 구성했다.

그 외에도 태, 단어 등 마이너 수정을 진행했다.

* 챗GPT : Dogfooding means using your own product internally before it's released to users. This practice helps uncover bugs early—especially under intense, repeated use. In fact, out of 157 past project releases, 153 had major bugs that could have been prevented with more thorough internal testing. That’s why Engineering now recommends that every project go through at least one month of dogfooding before release.