새 팀원이 첫날 따라 할 README를 영어로 쓰고 있다. 맨 위 절 제목은 ## Setup으로 정했다. 그 아래 첫 단계에 "저장소를 클론한 다음 시드 스크립트로 로컬 DB를 세팅하세요"를 쓰려는데, 제목에 쓴 Setup을 그대로 써도 되는지, 띄어서 set up으로 써야 하는지 헷갈린다. 한국어로는 '세팅'도 '세팅하다'도 같은 단어라서 고민할 일이 없었다.
| 용어 | 뜻 |
|---|---|
| 동사(verb) | 무엇을 하는지, 어떤 상태인지를 나타내는 말. 예: Restart the server.의 Restart |
| 명사(noun) | 사람·물건·일의 이름. 예: The server needs a restart.의 restart |
| 형용사(adjective) | 명사 앞이나 be 뒤에서 그 명사가 어떤지 꾸미거나 설명하는 말. 예: a slow query의 slow |
| 목적어(object) | 동사가 하는 일을 받는 대상. 예: Restart the server.의 the server |
| 대명사(pronoun) | 앞에 나온 명사를 다시 가리키는 it, them 같은 말. 예: The test failed. Rerun it. |
| 구동사(phrasal verb) | 동사에 up, in, out, into 같은 짧은 말이 붙어 한 덩어리로 새 뜻을 갖는 동사. 예: Look into the failing test. (look into: 원인을 살펴보다) |
README 첫 단계로 맞는 것은?
"After cloning the repo, ___ the local database with the seed script."
규칙: 동사는 띄우고 명사는 붙인다
A. 동사는 두 단어, 명사·형용사(adjective)는 한 단어로 쓴다. set up(처음 쓸 수 있게 준비하다, 설정하다), back up(사본을 떠 두다, 백업하다)처럼 동사에 up, in, down, back, out 같은 짧은 부사(adverb)가 붙은 것을 구동사(phrasal verb)라고 한다. 같은 뜻의 명사·형용사는 붙여서 한 단어로 쓴다. Microsoft 문서 스타일 가이드도 "Two words as a verb, one word as an adjective and a noun"이라고 적고 하이픈은 넣지 말라고 한다(Microsoft Style Guide: set up, setup, back up, backup, shut down, shutdown).
Back up the database before the migration.(동사)Restore it from last night's backup.(명사)The setup script takes about five minutes.(명사가 다른 명사 앞에서 꾸밈)
B. 동사인지 확인하려면 -ing나 -ed를 붙여 본다. 동사 자리라면 set up → setting up, back up → backed up, roll back → rolled back, log in → logging in처럼 앞 단어가 바뀐다(roll back: 이전 버전으로 되돌리다, log in: 계정으로 들어가다). 명사 자리는 앞에 a, the, this, daily가 오거나 뒤에 다른 명사가 붙는다(the setup, a daily backup, the rollback plan). -ed를 붙이려다 backuped, setuped처럼 없는 말이 나온다면, 그 자리는 동사인데 명사 모양을 넣은 것이다. 두 단어로 띄운다.
C. 목적어가 대명사면 반드시 가운데에 넣는다. set up처럼 둘로 나뉠 수 있는 구동사는 목적어가 명사일 때는 up 앞이든 뒤든 되지만, it, them 같은 대명사(pronoun)일 때는 반드시 동사와 부사 사이에 넣는다(British Council: Phrasal verbs).
Set up the database./Set the database up.(둘 다 맞다)Set it up.(맞다) /Set up it.(틀린다)Roll it back./Clean them up.(clean up: 다 쓴 것을 치우다, 정리하다)
D. 로그인은 sign in을 먼저 고려한다. log in(동사)과 login(명사·형용사)도 같은 규칙을 따른다. 다만 두 스타일 가이드 모두 동사로는 sign in(log in과 같은 뜻, 계정으로 들어가다)을 권한다. Google은 동사 자리에 sign in이 대체로 낫다고 하고, 문서화하는 도구가 log in이라는 말을 쓰면 그 말을 따르라고 한다(Google 개발자 문서 스타일 가이드: login, Google 개발자 문서 스타일 가이드: sign in). Microsoft는 UI에 그 말이 나오는 경우가 아니면 log in, login, log into를 쓰지 말라고 한다(Microsoft Style Guide: sign in, sign out). 명사형 sign-in은 Google은 쓰고 Microsoft는 피하라고 한다. 어느 쪽을 쓰든 동사 자리에 붙여 쓴 Login to the dashboard는 틀린다. Sign in to the dashboard, Log in to the dashboard처럼 쓴다.
표현: 개발에서 만나는 짝
| 표현 | 뜻 (동사 / 명사) | 예 |
|---|---|---|
set up / setup | 처음 쓸 수 있게 준비하다 / 그 준비, 구성 | Set up the local environment. / the setup guide |
sign in, log in / sign-in, login | 계정으로 들어가다 / 그 행위, 화면 | Sign in with your work account. / the login page |
back up / backup | 사본을 떠 두다 / 그 사본 | Back up the volume first. / Schedule a daily backup. |
check out / checkout | (Git에서) 브랜치로 옮겨 가다 / (쇼핑몰에서) 결제 단계 | Check out the release branch. / the checkout page |
roll back / rollback | 이전 버전으로 되돌리다 / 되돌리기 | Roll back the deploy. / The rollback took ten minutes. |
sign up / signup | 가입하다 / 가입 | Sign up with your email. / the signup form |
shut down / shutdown | 종료하다 / 종료 | Shut down the worker gracefully. / graceful shutdown |
clean up / cleanup | 치우다 / 정리 작업 | Clean up the temp files. / a cleanup function |
start / startup | 시작하다 / 시작 시점 | The app starts in two seconds. / startup time |
look up / lookup | (목록·DB에서) 찾아보다 / 조회 | Look up the user by email. / a DNS lookup |
start up(시작하다, 켜다)은 동사로 쓰지 말고 start를 쓰라는 것이 Microsoft 가이드의 권고다. startup은 기술 독자 대상 글에서 on startup, startup screen처럼 명사·형용사로 써도 된다고 한다(Microsoft Style Guide: start up, startup).
표의 check out, roll back, sign up, clean up, look up 짝은 두 스타일 가이드의 단어 목록에 따로 실려 있지 않다. 규칙 A를 그대로 적용한 예로 본다.
어디에 쓰느냐에 따라 어느 쪽이 오는지도 정해진다.
- 버튼: 누르면 일어나는 동작이니 동사, 두 단어.
Sign in,Back up now,Roll back. - 문서 절 제목: 절의 이름이면 명사(
## Setup,## Backup and restore), 할 일을 적은 제목이면 동사(## Set up the local environment). 한 문서 안에서는 한쪽으로 맞춘다. - 커밋 제목: 명령형(imperative)이니 첫 단어는 동사, 두 단어.
Set up CI for the docs site,Clean up unused feature flags. 명사는 목적어 자리에 온다.Add cleanup for expired sessions. 명령형은 Unit 1에서 다뤘다.
set up, back up, log in처럼 두 단어, 명사는 setup, backup, login처럼 한 단어입니다.setup the environment, login to the server처럼 붙여 쓰기 쉽습니다. 동사 자리면 띄웁니다.함정 찾기: AI가 쓴 README
로컬 환경 세팅 방법을 README에 넣을 영어 문단으로 써 줘.
- 테스트 계정 로그인
- DB 초기화 전 백업
의심스러운 줄을 모두 눌러 표시한 뒤 “검토 끝”을 누르세요. 함정은 3개입니다.
연습
1. 문서 사이트에 CI를 새로 구성한 커밋의 제목(명령형)은? "___ CI for the docs site"
2. 배포 런북: 배포가 실패하면 그 배포(it)를 이전 버전으로 되돌린다.
"If the deploy fails, ___."
3. 운영 문서: 매일 한 번 사본을 뜨도록 예약하라.
"Schedule a daily ___."
4. Google 개발자 문서 스타일 가이드가 권하는 대로, 로그인 안내 문장을 쓸 때:
"To continue, ___ with your work account."