Technical Documentation - Using Punctuation

* Full stop or period

US English에서는 문장의 마지막 부분에 위치한 구두점을 'period'라고 한다. BR English에서는 이것을 'full stop'이라고 한다. 기술문서를 작성할 경우 이러한 구두점을 자주 사용하겠지만, 이것의 이름을 굳이 거론할 필요는 없으므로, 이 둘의 이름을 기억만 해 놓는것이 좋을것이다.

* Inserting a serial comma

We interviewed many engineers, scientists, and academics.

위 문장에서 밑줄 친 부분에 쉼표(comma)를 붙이는게 좋을까? 마지막 항목(academics)과 그 이전 항목(scientists) 사이에 위치한 'and' 전에 붙은 쉼표는 'serial comma'라고 알려져있다. 물론 밑줄친 부분의 쉼표는 생략해도 읽는데에 큰 지장을 주지는 않지만, 아래의 예에서는 반드시 표기하는것이 좋다. (and가 어디에 걸리는지 확실히 할 필요가 있다)

We interviewed 32 engineers and technologists in the European manufacturing sector, 17 scientists and their lab assistants in the North American pharmaceutical industries, and 29 professors and assistant professors in Australasia.

따라서 기술 문서를 작성할 경우 serial comma를 첨가해 주는것이 좋다. 중요한것은 독자가 문장을 명확하게 이해할 수 있도록 하는것이다.

* Using semicolons

세미콜론(;)을 사용하는데에는 두가지 조건이 있다: 세미콜론으로 나뉘어진 두 문장은 반드시 완성형 문장이어야 한다는 것이다; 또한 각 문장에 있어서의 핵심 내용이 서로 연결되어야 한다. < 이 예시 문장을 참고하라. 따라서 아래와 같은 문장이 가능하다.

To verify our hypothesis, we interviewed 78 technical professionals in North and South America; their responses revealed markedly diverse opinions.

* Using colons

콜론(:)을 사용함으로서 콜론 바로 앞에 위치한 단어에 대한 설명을 하는데 사용할 수 있다.

Here is a useful idea: store the information in a separate file.

세미콜론의 경우와 마찬가지로, 콜론 앞에는 완성형 문장이 위치해야 한다.

* Introducing a List

콜론을 사용하여 연쇄되는 호(subparagraphs)의 목록에 대해 설명할 수 있다.

Ship the following items to site 17:

• Two manometers model 200A.

• Strip recorder SR2020.

• Printer Nabuchi 300.

Introducing solution XLA will have the following effects:

• There will be a noticeable increase in higher-level abstractions.

• The response time to the initial trigger will be 40% faster.

• There will be no need to monitor the flow.

하지만, 만약 설명하는 문장이 완성형 문장이 아니라면 아래와 같은 경우가 가능하다.

• 설명하는 문장 마지막의 콜론을 생략할 수 있다,

• 각 항목의 문장의 시작을 소문자로 시작할 수 있다.,

• 마지막 항목을 제외한 모든 항목에 대하여 컴마를 사용할 수 있다.

• 마지막 이전의 항목에 있어 컴마를 기입한 후 'and'를 추가하며

• 마지막 항목은 period/full stop 기호로 문장을 맺는다.

따라서 아래와 같이 사용될 수 있으며, 아래와 같이 하나의 문장으로 표현될 수도 있다. (물론 호를 사용하는것이 독자에게 있어 이해하기 훨씬 쉽다)

We need you to ship

• two manometers model 200A,

• a strip recorder SR2020, and

• a Nabuchi printer model 300.

We need you to ship two manometers model 200A, a strip recorder SR2020, and a Nabuchi printer model 300.

* Punctuation after a quotation mark

미국에서는 인용구에서의 구두점은 인용구 안에 위치한다. 

‘…in time to offset the reduction.’

하지만 영국에서는 구두점을 인용구 밖에 위치한다.

‘…in time to offset the reduction’.

기술문서를 작성할때에는 인용구 안에 구두점을 사용하는것을 추천한다. 이 원칙은 물음표(?) 혹은 느낌표(!)를 사용할때도 마찬가지로 사용될 수 있다. ('인용부호를 위치한 후에 이렇게 사용하는경우는 거의 없지 않은가'?)

‘It will have a disastrous effect!’

‘Can we risk increasing the product’s price?’

* Single or Double quotation marks?

유럽에서는 작은 따옴표('...') 를 사용하는것이 큰 따옴표("...")를 사용하는 것보다 더욱 자주 쓰인다. 하지만 미국에서는 큰 따옴표가 더욱 자주 쓰인다. 기술문서를 작성하는데 있어서는 작은 따옴표를 사용하는것을 권장한다. 이러한 원칙의 큰 장점이라면.. 쉬프트(shift)키를 누르지 않아도 된다는 것이다!

하지만 만약 인용구 안에 인용구를 삽입해야 한다면, 번갈아 가면서 사용해야 한다.(개인적으로는 큰따옴표 안에 작은따옴표를 삽입하는것을 추천한다)

‘Xxxxxxx “Xxxxxxxx” xxxxxx.’ or: “Xxxxxxx ‘Xxxxxxxx’ xxxxxx.”

* Punctuation in names and addresses

편지에 첨부되는, 이름과 주소에 되는 기입방법의 최근 경향으로는, 모든 구두점을 생략하는 것이다. 이러한 경향은 유럽에서는 보편적이지만, 미국에서는 그렇게 보편적이지는 않다. 각국의 우편 기구에서는 문자인식(OCR)에서의 혼동을 방지하기 위해 구두점이 생략되는것을 더욱 선호하는 편이다.따라서 아래와 같이 표기하는 편이 좋다.

Mr David Orlikow

Quality Control Manager

Multiple Industries Inc

235 Worldwind Drive

Corisand FL 19821-2237

USA

북미지역에서는 시, 구, 도, 그리고 우편번호가 모두 한 줄에 표기되는것을 권장하기 때문에, 아래와 같이 각 항목은 공백 하나(' ')로 연결하고 우편번호와 주소의 사이는 공백 두개('  ')로 연결하는 표기를 사용할 수 있다. 

Corisand FL 19821-2237

물론 다른 국가에서는 각기 다른 가이드라인을 제공할 수 있으므로, 대상지역의 표기법에 대해 미리 조사해 두는것이 좋다.

======================

INTECOM에서 발간된 Guidelines for Writing English Language Technical Documentation for an International Audience 문서의 Article 5: Using punctuation 부분을 번역하였다. 지난 워크샵에서 언급된 문서작성에서의 consistency에 대해 생각나서 정리해보았다. 이와 비슷한 규칙으로 The Chicago Manual of Style, Associated Press (AP) Style등이 있는데 한번에 훓어보기에는 분량이 많다.. 이왕 정리한김에 다음 게시물로는 코딩 스타일에 대해 정리해 보아야겠다.