Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FEAT] add ko translated guildline #878

Merged
merged 22 commits into from
May 26, 2021
Merged

[FEAT] add ko translated guildline #878

Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
55debbf
[FEAT] add ko translated guildline
hochan222 May 16, 2021
e18eef3
[FEAT] add css syntax guide
hochan222 May 16, 2021
9a19859
[FEAT] add api/javascript word list
hochan222 May 16, 2021
98dc0ed
[FEAT] add http word list
hochan222 May 16, 2021
93ee8ca
[FEAT] add common rules
hochan222 May 16, 2021
4003f2c
Update docs/ko/translation-guide.md
hochan222 May 17, 2021
9087c5b
Update docs/ko/translation-guide.md
hochan222 May 17, 2021
59564ef
Update docs/ko/translation-guide.md
hochan222 May 17, 2021
e231628
[FEAT] add Q&A macro, 1
hochan222 May 18, 2021
2cefe2e
[FEAT] add Q&A ko mdn site, 2
hochan222 May 18, 2021
87bd21a
[FEAT] add Q&A mistranslation, 3
hochan222 May 18, 2021
9b83a52
[FEAT] add Q&A how to contribute, 4
hochan222 May 18, 2021
9f8859b
[FEAT] add Q&A how to tag label, 5
hochan222 May 18, 2021
9a4d992
[FEAT] add First Contribution Guideline
hochan222 May 18, 2021
2e2b373
[FEAT] add Translating heading IDs
hochan222 May 18, 2021
3d4ef73
[FEAT] add Translating code blocks
hochan222 May 18, 2021
0c2cd54
[FEAT] add Line breaks in HTML source
hochan222 May 18, 2021
4d49295
[FEAT] add content table
hochan222 May 18, 2021
62f8023
[FEAT] add conclusion
hochan222 May 18, 2021
65faa5a
[FIX] type err, navigation
hochan222 May 18, 2021
bc983f6
[FEAT] add yari quick start
hochan222 May 18, 2021
1190b6d
[REFACTOR] flow translate
hochan222 May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
236 changes: 236 additions & 0 deletions docs/ko/translation-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
## 목차

**1. [MDN 번역 콘텐츠에 대한 일반 지침](#MDN-번역-콘텐츠에-대한-일반-지침)**
**2. [첫 기여자들을 위한 지침 안내](#첫-기여자들을-위한-지침-안내)**
**2. [yari 빠른 사용법](#yari-빠른-사용법)**
**3. [번역 가이드](#번역-가이드)**
**4. [용어 지침](#용어-지침)**
**5. [자주 묻는 질문](#자주-묻는-질문)**
**6. [맺음말](#맺음말)**

---
## MDN 번역 콘텐츠에 대한 일반 지침

이 문서는 한국(ko) 지역에 대한 번역 지침입니다. 귀하의 로케일에 대한 몇 가지 특정 지침을 문서화하는 페이지를 추가하고 싶은데 아직 여기에 나타나지 않는 경우, 하나를 추가하거나 [Locale Teams](https://github.com/mdn/translated-content#policies-for-active-community-maintenance-teams)에 문의해주세요.

마찬가지로 추가하려는 일반 지침에 대한 좋은 아이디어가 있는 경우 환영합니다. Issue를 열고 문제에대해 이야기해주세요. 다음은 한국어 번역 지침 원칙의 주요 내용입니다.

## 첫 기여자들을 위한 지침 안내

첫 기여자분들을 위해 다음 [issue 827](https://github.com/mdn/translated-content/issues/827)에 기여 방법을 작성했습니다. 참고해주세요.

추가적으로 궁금하신점 있으시면 [Kakao Talk (#MDN Korea)](https://open.kakao.com/o/gdfG288c)에 이야기해주세요.

## yari 빠른 사용법

yari 가 content repo에 내장돼있습니다. 세부 절차는 [다음 링크](https://github.com/mdn/translated-content#making-contributions)를 참고해주세요.

1. [content](https://github.com/mdn/content) 하고 [translated-content](https://github.com/mdn/translated-content) 다운 받습니다. (fork 한뒤)
2. content 폴더에 들어가서 `yarn install`
3. content 폴더 root에 .env 파일을 추가합니다. (translated-content/files 경로 추가, vscode editor의 경우 `EDITOR=code` 추가)

```
CONTENT_TRANSLATED_ROOT=/path/to/translated-content/files
EDITOR=code
```
4. `yarn start`

다음과 같이 진행하면 아래와 같이 실시간으로 반영사항 확인할 수 있고 4가지 편집 버튼으로 편집할 수 있습니다.
![image](https://user-images.githubusercontent.com/22424891/117309001-002e0500-aebd-11eb-9842-8f78a99e8873.png)

## 번역 가이드

### heading ID 번역

기사 제목에는 거의 항상 ID가 주어지는데, 기사 내에서 네비게이션을 자동으로 생성하고 실시간 샘플을 생성하기위한 코드 블록을 식별하는 등의 이유가 있습니다. 제목을 번역 할 때 ID도 같이 번역 할 필요가 없습니다. 나머지 슬러그는 번역되지 않으므로 모든 것이 일관되게 유지됩니다.

예를 들면:

```html
<h2 id="tutorials"> Tutorials </h2>
```

`ko` 지역 에서

```html
<h2 id="tutorials"> 튜토리얼 </h2>
```

일반적으로 모든 ID를 소문자로 작성하는 것이 좋습니다. 플랫폼은 어쨌든 렌더링시 자동으로 변환하지만 소문자로 유지하면 변환으로 인해 수동으로 만든 앵커 링크가 작동하지 않을 가능성이 적습니다.

### code block 번역

코드 블록을 번역 할 때 주석, 문자열, 변수 이름 및 출력물을 번역하는 것이 좋습니다.

그러나 구문과 같은 실제 코드 용어를 번역하지 마십시오. 예제는 작업을 마친 후에도 계속 작동해야합니다.

또한, 예제 번역을 고려할 때, 일부 예제는 별도의 저장소에 있는 라이브 버전 또는 소스 코드에 연결된다는 점을 염두에 두십시오. 여러분은 또한 번역 된 페이지에서 링크 할 외부 코드 예제의 번역 된 버전을 만드는 것을 고려할 수도 있습니다.

### HTML 소스의 줄 바꿈

일부 기사 소스 코드에서, 반드시 필요하지 않은 블록 수준 요소에서 줄 바꿈을 찾을 수 있습니다. 예를 들면 다음과 같습니다.

```html
<p>The
<code><strong>HTMLCanvasElement</strong></code><strong><code>.transferControlToOffscreen()</code></strong>
method transfers control to an {{domxref("OffscreenCanvas")}} object, either on the main
thread or on a worker.</p>

<pre
class="brush: js">OffscreenCanvas HTMLCanvasElement.transferControlToOffscreen()</pre>
```

일반적으로 소스 코드에서 이와 같은 줄 바꿈을 사용하지 않으므로 원하는 경우 자유롭게 제거 할 수 있으며 새 번역을 만들 때 추가하지 마십시오. 그러나 최종 렌더링 결과에 영향을 미치지 않으므로 이를 제거하는 데 너무 많은 시간을 소비하지 마십시오.

## 용어 지침

### 공통

- 브랜드 이름은 번역하지 않습니다.

```diff
- 자바스크립트
- 씨에스에스
- 모질라
+ JavaScript
+ CSS
+ Mozilla
```

- "무슨무슨 값" (numeric value, integer value, ...) 같은 경우, 항상 띄어서 표기합니다.
hochan222 marked this conversation as resolved.
Show resolved Hide resolved
- 통일성을 위해 "반환 값" 같은 경우 띄어서 표기합니다.
- 예: 정수 값, 소수 값, 반환 값, 기본 값
- 틀린 예: 정숫값, 소숫값, 반환값, 기본값

**사전 순으로 용어집을 편집해주세요.**

| 용어 | 번역 | 기타 |
| --- | --- | --- |
| Accessibility concerns | 접근성 고려사항 | Heading |
| Attribute | 특성 | |
| Boolean | 불리언 | |
| Class | 클래스 | |
| Content(s) | 콘텐츠 | |
| Context | 맥락 | |
| Document | 문서 | |
| Element | 요소 | |
| Entity | 개체 | |
| Enumerated | 열거형 | |
| Example | 예제 | Heading |
| Expression | 표현식 또는 식 | |
| Global | 전역 | |
| Glossary | 용어 사전 | |
| Grammar | 문법 | |
| Literal | 리터럴 | |
| Method | 메서드 | |
| Object | 객체 | |
| Origin | 출처 | |
| Override | 재정의 | |
| Primitive | 원시 (값) | |
| Property | 속성 | |
| Psuedo- | 의사- | |
| Reference | 참고서 | |
| Regular expression | 정규 표현식 | |
| Rendering | 렌더링 | |
| See also | 같이 보기 | Heading |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| See also | 같이 보기 | Heading |
| See also | 참고 자료 | Heading |

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

많은 부분에서 참고 자료로 돼있어서 리뷰했습니다.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

전체 페이지에 대해 검색했을 땐 "같이 보기"가 더 많이 나와요.

  • >같이 보기<: 702개 파일 내 702번 등장
  • >See also<: 377개 파일 내 382번 등장
    • 번역이 덜 끝난 것들
  • >더 알아보기<: 93개 파일 내 94번 등장
    • 보통 일반 문서에서는 잘 안쓰이고 Glossary의 "Learn more"에 보입니다.
  • >함께 보기<: 67개 파일 내 67번 등장
  • >참고\s?자료<: 6개 파일 내 6번 등장

비중은 이렇구요, <strong>: 높은 중요도 요소#같이_보기 같은 경우 <b>, <em>, font-weight만 있고 외부 링크같은 것이 없어서 "참고 자료"는 덜 어울리지 않을까? 하여요.

Copy link
Member Author

@hochan222 hochan222 May 18, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

앗 제가 띄어쓰기를 안해서 같이보기로 검색해서 적게 나왔습니다. 다음에는 의견을 제시할때 저도 정량적 지표와 함께 제시하도록할게요! 이해했습니다. 알려주셔서 감사합니다!

비중은 이렇구요, <strong>: 높은 중요도 요소#같이_보기 같은 경우 <b>, <em>, font-weight만 있고 외부 링크같은 것이 없어서 "참고 자료"는 덜 어울리지 않을까? 하여요.

저도 동의합니다! 그대로 유지하는게 좋아보입니다. 별도로 향후에 같이 보기(See also) 와 같이 Heading에 영어가 같이 명시돼있는경우에 대해서는 한글만 허용하는게 좋을까요? Heading에 대해서는 혼란을 주는 단어들이 없다고 생각해서 의견을 제시했습니다!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

네! 헤딩이 뭐시기(Blah) 형식인 것은 1. 모두 오래된 레거시 페이지들이고, 2. 가독성을 너무 해쳐서, 영어 제거하는 쪽에 대찬성합니다

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

네! 좋아요! 답변해주셔서 감사합니다. 좋은 밤 보내세요 :)

| Section | 구획 | |
| Specification | 명세 | |
| Statement | 명령문 또는 문 | |
| Syntax | 구문 | |
| Tutorial | 자습서 | |
hochan222 marked this conversation as resolved.
Show resolved Hide resolved
| Usage notes | 사용 일람 | Heading |
| User agent | 사용자 에이전트 | |

### CSS

명세 이름은 번역하지 않습니다.

```diff
- CSS 글꼴 모듈 레벨 4
+ CSS Fonts Module Level 4
```

명세 이름이 본문에 나오더라도 번역하지 않습니다. (예: "`<number>` 구문은 CSS Fonts Level 4가 추가했습니다.")

**사전 순으로 용어집을 편집해주세요.**

| 용어 | 번역 | 기타 | 참고 링크 |
| --- | --- | --- | ------ |
| At-rule | @규칙 | | |
| Block | 블록 | | |
| Border | 테두리 | | |
| Box | 박스 | | |
| Flexbox | 플렉스박스 | | |
| Flow | 플로 | 레이아웃 방식일 경우에 한정 | |
| Formal syntax | 형식 구문 | | |
| Grid | 그리드 | | |
| Inline | 인라인 | | |
| Layout | 레이아웃 | | |
| Longhand property | 본디 속성 | | |
| Margin | 바깥 여백 | | |
| Padding | 안쪽 여백(패딩) | | [CSS 기본 박스 모델 입문](https://developer.mozilla.org/ko/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model) |
| Shorthand property | 단축 속성 | | |

### API/JavaScript

**사전 순으로 용어집을 편집해주세요.**

| 용어 | 번역 | 기타 | 참고 링크 |
| --- | --- | --- | ------ |
| Argument | 매개변수 | | |
| Callback | 콜백 | | |
| Fulfilled | 이행(함) | | |
| Handler | 처리기 | 이벤트 처리기 | |
| Interface | 인터페이스 | | |
| Iterate | 순회 | | |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

순회로 해도 괜찮을까요? 반복("반복 가능한 객체")과 순회("순회 가능한 객체")의 검색 결과 차이가 정말 상당해서요.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Iterate: 순회
Loop/Repeat과 구별하기 위해서 "순회"로 번역했었습니다. ("배열을 반복합니다." 대신 "배열을 순회합니다.")
Iterator는 반복기/반복자가 아닌 순회기/순회자가 됩니다.
그런데 일반적으로 "반복" 용례가 훨씬 많아서 잘 모르겠네요.

Iterator 자체는 반복기/반복자가 좋다고 생각합니다. 역사적으로 볼때 Iterator를 반복기/반복자로 인식하는 사람이 더 많다고 생각합니다.
문제가 Iterate의 경우인데, Iterator를 반복기/반복자라고하고 Iterate는 순회라는 표현을 쓰면 아무래도 혼동이 많을까요?

Copy link
Member

@alattalatta alattalatta May 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Iterate에 대해서는 의견을 좀 더 모아보면 좋겠네여.

Iterator에 대해서는 아무래도... 그래야 할 것 같아요. -기와 -자 중에서도 -자 쪽이 압도적인 것 같아요. 다만 MSDN은 C# 문서에서 반복기로 사용하고 있긴 하네요.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cos18 @GwangYeol-Im @nKiNk @pje1740 @yechoi42 @yujo11 어떻게 생각하시나요?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Iterator는 말씀해주신대로 반복자가 가장 익숙하네요. Iterate는 '순회'로 표기해도 이해하는데 문제없을 것 같습니다. 오히려 반복이 어색한 느낌...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

저도 순회로 하는게 좋은것같습니다. 우선은 순회로 올리겠습니다!

| Listener | 수신기 | 이벤트 수신기 | |
| Mixin | 믹스인 | | |
| Parameter | 매개변수 | | |
| Pending | 대기 | | |
| Prototype | 프로토타입 | | |
| Reject | 거부 | | |
| Resolve | 이행 | | |
| Settled | 처리 | | |
| Scope | 스코프 | | |

### HTTP

| 용어 | 번역 | 기타 | 참고 링크 |
| --- | --- | --- | ------ |
| Idempotent | 멱등성 | | |
| Request Body | 요청 본문 | | |
| Response Body | 응답 본문 | | |

## 자주 묻는 질문

**1. `{{Compat}}` 하고 `{{Specifications}}` 이건 ko 에서는 보이지 않습니다.**

문서 frontmatter에 browser-compat 키 추가해주세요. (참고: 퀵에디터로 수정하면 frontmatter가 보이지 않습니다.)

<img src="https://user-images.githubusercontent.com/22424891/118590427-61b77300-b7dd-11eb-803e-daf51bb8edbe.png" height="300px" />

**2. 한국어로된 MDN 사이트는 못보나요?**

https://developer.mozilla.org/en-US/docs/Web/HTML 와같이 영문 페이지라면 중간에 en-US만 https://developer.mozilla.org/ko/docs/Web/HTML 와같이 ko로 바꿔주시면 번역본으로 보실 수 있습니다.

페이지가 존재하지 않는 경우 번역을 통해 기여를 하실 수 있습니다. 번역 기준 버전은 en-US입니다.

**3. MDN 강의를 보면서 공부를 하고 있는데 다음과 같은 문장을 보게 되었습니다. 번역이 이상합니다.**

특정기간 MDN 문서의 편집이 자유로워서 이상한 번역이 많습니다. 괜찮으시다면 PR을 보내주시거나 issue를 생성해서 해당 페이지가 조치 받게 해주실 수 있으신가요?

**4. 제가 초보라서 번역에 어떻게 기여하는지, 또 따라야 할 공식 지침 같은 것이 있는지 몰라서 손을 못 대고 있는 상황입니다.**

단순한 제보는 https://github.com/mdn/translated-content/issues 다음 페이지에서 New issue를 눌러서 이슈 작성을 해주시면 됩니다! 혹시 직접 수정해서 기여하고 싶으시면 https://github.com/mdn/translated-content/issues/827 이 절차대로 진행해주실 수 있으신가요? 기여해주셔서 감사합니다.

**5. Issue의 라벨은 어떻게 붙이나요?**

라벨은 레파지토리 관리자분들께서 확인 후 붙여주십니다.

## 맺음말

번역 작업에 대한 절대적 기준을 설정하는 것도 어렵고, 올바른 언어 사용을 위한 절대적 기준을 마련하는 것도 어렵습니다. 따라서, 위의 원칙과 문제에 직면했을 때 큰 부담을 느끼지 않으셨으면 좋겠습니다. 궁금한 점이 있으시면 현지 번역팀에 부담없이 문의 해주시기 바랍니다.

번역을 보내 주시면 검토자가 디버깅을 돕고 부주의 한 부분이 무엇인지 알아낼 것입니다. 문제가 해결되면 번역을 병합합니다.

번역에 직접 기여할 준비가 되지 않은 경우에는 문제가되지 않습니다. MDN에서 결함이있는 번역을 찾아 issue를 통해 알릴 수 있습니다. 또는, 너무 어렵지 않고 해결되지 않은 문제를 찾아서 해결해보세요. 이것은 번역 기여의 첫 단계를 수행하는 비교적 간단한 방법입니다. 여러분의 기여를 진심으로 기대합니다.