이공계 Technical Writing Guide

책 [이공계 Technical Writing 가이드]를 읽고 정리한 문서이다.

Technical Writing이란

글쓰기와 대한민국의 연구원

글쓰기가 중요한 이유는 알고 있는 내용이 100%, 전달하는 능력이 50%라면 전달되는 내용은 50%이다. 하지만 알고 있는 내용이 80%, 전달하는 능력이 100%라면 전달되는 내용은 80%이므로 '해당 분야의 지식을 어느 정도나 알고 있는가' 만큼 '잘 표현하는가'도 중요하다.(비즈니스 세계의 의사소통 도구는 문서)

연구원으로서의 영향력을 높이기 위해서는 정확하고 명확하게 표현할 수 있는 글쓰기 능력이 필수이다.

Technical Writing이란 무엇인가

다른 사람과 소통하기 위해서 하는 글쓰기를 모두 Technical Writing이라고 책 저자는 언급한다. 즉, 저자가 아닌 독자의 입장에서 쓰는 글쓰기를 Technical Writing이다.

연구원이 아닌 직장인들도 Technical Writer가 아니어도 기본적으로 Technical Writing을 해야 한다는 인식을 하는 것이 중요하다.

Technical Writing의 필수 요소는 논리적인 구성, 알기 쉬운 문장, 시각적인 표현이다.

따라서 문서의 제목과 목차에 작성자의 말하고자 하는 내용을 대변할 수 있는 키워드를 반영해야 한다. 문서의 논리를 보여 줄 수 있도록 내용 배열에도 신경을 써야 한다.

독자가 쉽게 읽고 이해할 수 있는 문장과 맞춤법 오류가 없는 문장으로 작성해야 한다.

시각적인 표현은 예전에는 부가 요소였으나 지금은 가장 먼저 고려해야 하는 요소이다. 기술문서라서 글로써 명확하게 설명하기 힘든 부분이 더 많을 수 있다. 이런 경우 블록 다이어그램이나 순서도 등 사각 요소를 활용하면 작성하는 사람도, 읽는 사람도 쉽게 소통할 수 있다.

나는 왜 Technical Writing을 잘해야 하는가

현대는 지식 사회라 한다. 지식 사회에서의 가치는 지식에 있고, 많이 공유되어야 그 가치가 올라간다. 내 지식이 많이 공유될 수 있도록 공유하는 방법은 해당 지식을 문서화하는 것이다. 내 가치를 높이기 위해 내가 가진 지식이 많은 사람들에게 유용하게 공유될 수 있도록 해야 한다. 그렇게 하기 위해 기본적으로 상대가 이해하기 쉬운 글을 써야 한다.

연구원들에게 글쓰기가 힘든 이유는 무엇인가

연구/개발 직군 인력들의 역량은 기술에 대한 전문성만으로는 부족하다. 같이 일하는 동료/상사와의 커뮤니케이션뿐만 아니라 기술을 잘 모르는 소비자/사용자와의 소통 능력도 연구/개발 직군의 인력들이 갖춰야 하는 필수 역량이다. 연구원/개발자는 상품이나 기술에 대한 연구/개발만 하면 되고, 파는 것은 마케팅/영업 부서의 몫이던 시대는 지났다.

제대로 된 커뮤니케이션을 위해서 먼저 상대를 이해시켜야 하며 동시에 상대를 배려해야 한다.

우리나라는 사회 구성원들이 문서로써 일을 하는 문화에 익숙하지 않은 것이 사실이고 관련 규칙도 명확하게 정비되어 있지 않은 상황이다. 이런 상황은 글로벌 시장에서의 경쟁력에 큰 손해일 수 있다.

직접 영어로 쓸 수 없다면, 기계도 이해할 수 있도록 써야 한다

우리 글로 우리끼리만 소통하여 이룰 수 있는 일은 많지 않아 글로벌 시장과 소통할 수 있어야 한다. 언어 장벽을 넘어야 하나 다행히 글로벌 언어로써 영어가 통용되고 있다.

영어로 소통하기 위해 문서 작성자가 영어로 작성할 수 있다. 하지만 번역가나 기계 번역을 활용하기도 한다. 번역가나 기계 번역이 이해할 수 있게 정확하고 이해할 수 있는 문장을 작성해야 한다.

번역 툴의 기술문서 문장을 적용해본 경우의 예시다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장하는 명령어이며 기본으로 EMS에서 입력받은 패키지를 FTP로 다운로드 한다.

This MMC imperative downloads package that is been imperative that store new package to system and input in EMS to basic to FTP.

Technical Writing의 원칙 중 '짧게 쓰라'와 '주어를 생략하지 않는다'를 적용해 1차로 수정한다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장하는 명령어이다.
이 MMC 명령어는 기본으로 EMS에서 입력받은 패키지를 FTP로 다운로드 한다.

This MMC imperative is imperative that store new package to system.
This MMC imperative downloads package that is inputted in EMS to basic to FTP.

Technical Writing의 원칙 중 '중복되는 단어 또는 의미는 삭제하라'를 적용해 2차로 수정한다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장한다.
이 MMC 명령어는 기본적으로 EMS에서 입력받은 패키지를 FTP로 다운로드 한다.

This MMC imperative stores new package to system.
This MMC imperative downloads package that is inputted i EMS basically to FTP.

Technical Writing의 원칙 중 '문장 구성 요소의 배열을 적절하게 하라'를 적용해 3차로 수정한다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장한다.
기본적으로 이 MMC 명령어는 EMS에서 입력받은 패키지를 FTP로 다운로드 한다.

This MMC imperative stores new package to system.
Basically, this MMC imperative downloads package that is inputted in EMS to FTP.

Technical Writing의 원칙 중 '조사를 정확하게 사용하라'를 적용해 4차로 수정한다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장한다.
기본적으로 이 MMC 명령어는 EMS에서 입력받은 패키지를 FTP를 이용하여 다운로드 한다.

This MMC imperative stores new package to system.
Baically, this MMC imperative downloads package that is inputted in EMS using FTP.

우리말 '명령어'에 해당하는 적절한 영어 단어를 해당 분야의 Usage를 반영한 표현으로 바꾸어 마무리한다. 번역 업계에서는 문서의 번역 작업을 단순히 문장을 사전 상 용어로 번역하는 것이 아니라 현장에서 사용하는 용어/Usage로 재작성한다는 의미로 'Translation'이 아닌 'Localization'이라고 한다.

이 MMC 명령어는 시스템에 새로운 패키지를 저장한다.
기본적으로 이 MMC 명령어는 EMS에서 입력받은 패키지를 FTP를 이용하여 다운로드 한다.

This MMC command stores new package to system.
Basically, this MMC command downloads package that is inputted in EMS using FTP.

위와 같이 기계를 이해시키는 것은 멀고 험한 길인 듯하다. 몇 가지 원칙만 준수한다면 불가능한 일은 아니다. Technical Writer들도 문장을 쓸 때 고민을 많이 하게 된다. 이 책의 저자가 해주는 조언은 "문장에는 정답이 없다. 의미가 통하는 것이 최우선이며 내가 이 문장을 번역한다면 어떻게 할까를 생각해보면 좀 더 정답을 찾는 데 도움이 될 것이다." 이다.

기계를 이해시키기 위해서는 우선 단순하고 명확해야 한다.

글쓰기 분야의 VOC(Voice Of Customer)

Writing과 관련해서 고객은 주로 다음과 같은 항목에 불만을 토로한다.

• 문서의 작성 목적이 명확하지 않다.
• 문서의 구조가 논리적이지 않다.
• 문서의 결론이 명확하지 않다.
• 문서의 내용이 너무 상세하거나 충분하지 않다.
• 문장의 의미가 명확하지 않다.
• 용어 사용이 부적절하다(전문 용어의 오남용, 애매한 용어, 부적합한 용어).
• 오탈자가 많다.

VOC	해당 여부(O/X)	해결책
VOC	O / X
명확하지 않은 목적과 내용	O / X
이해할 수 없는 구조와 논리	O / X
명확한 결론이 없음	O / X
너무 상세하거나 충분하지 않음	O / X
잘 알아들을 수 없는 문장 또는 긴 문장	O / X
전문 용어의 부적절한 사용	O / X
오탈자	O / X

Technical Writing 대원칙

대원칙 1: 대상 독자와 작성 목적을 명확하게 정의하라

Technical Writing은 소통을 목적으로 작성하는 모든 글이라고 했듯, 그 목적은 소통에 있다. 소통의 기본은 상대방의 입장에서 말하고 행동하는 것이다. 따라서 Technical Writing은 철저히 독자 입장에서 글을 쓰는 것을 기본으로 삼아야 한다.

글쓰기를 할 때 누가 읽을 것이며, 상대는 무엇을 알고 싶어 하는지, 나는 그 사람에게 어떤 정보를 전달해야 하는지를 정확하게 정의하는 과정이 필요하다.

소화전 사용방법을 활용한 예시이다.

1. 소화전 함을 열고 관창(노즐)을 잡고 적재된 호스를 함밖으로 끄집어 낸다.
2. 소화전 밸브를 왼쪽으로 돌려서 개방한다.
3. 두 손으로 관창(노즐)을 잡고 불이 난 곳까지 호스를 전개하여 불을 끈다.
4. 화재 진화를 마치면 소화전 밸브를 잠근다.

위 예시에서 불이 나서 소화전을 사용해야 하는 경우에 호스를 함 밖으로 꺼내고 불을 끈 후 밸브를 잠근다는 설명은 하지 않아도 될 설명이다. 위 1번과 4번보다는 실제로 소화전을 사용할 때 주의해야 할 사항이나 꼭 알아야 할 사항들에 대해 기술하는 것이 더욱 중요한 일이다.

대원칙 2: 대상 독자를 이해시켜야 한다

대상 독자와 작성 목적이 명확해지면 어떤 내용을 어떻게 작성할지에 대한 틀이 잡히게 된다. 그런 다음 필요한 것은 '나는 독자를 이해시켜야 한다'는 소명의식이다.

상대를 이해시키기 위해서 상대 입장이 되어야 한다. 내 입장에서 내가 익숙한 용어를 사용해서는 상대를 이해시킬 수 없다. 독자가 어느 정도의 지식을 가졌으리라 예상하지 말아야 한다.

맥심 아이스 커피 광고 카피를 활용한 예시이다.

찬물에도, 얼음에도 잘 녹으니까 <맥심 아이스 커피믹스 광고 카피>

동결건조 기술로 인해 찬물에도 잘 녹는 커피의 광고이다. 독자는 기술보다는 자신이 누릴 수 있는 혜택에 더 많은 관심이 있을 것이다.

Technical Writing은 한마디로 '목적에 부합하면서 독자에게 먹히는 글쓰기'를 뜻한다.

Technical Writing 세부 원칙

문서의 구성을 먼저 고민하라

문서를 작성할 때 '논리성'에 대한 고민을 한 번쯤은 해봤을 것이다. 문서의 논리라는 것은 문서 내용의 구성, 즉 배열의 문제라고 할 수 있다. 동일한 내용이라도 어떻게 배열하느냐에 따라 독자가 이해하는 폭에 큰 차이가 있다.

논리를 이야기할 때 우리가 생각해야 할 단어는 'MECE(Mutually Exclusive & Collectively Exhasutive)'이다. MECE는 Mckinsey & Company에서 업무 또는 문서 작업의 기본으로 활용하고 있는 개념이다. 쉽게 풀어 해석하자면 '서로 중복되지 않으며 전체적으로 누락이 없다.' 정도로 해석할 수 있다. 위 관점에서 문서를 작성하고자 할 때 다음 사항들을 우선 고려해야 한다.

• 작성 목적을 명확하게 해야 한다.
  • 무슨 내용을 어떻게 작성할 것인지 기획한다.
• 숲을 먼저 보여주고 나무를 설명한다.
  • 기획 의도에 맞는 내용을 기초로 MECE적으로 문서 체계를 잡는다.
• 나무를 설명할 때도 나무의 전체 모습을 먼저 보여주고 부분을 설명한다.
  • 개요 -> 전체 윤곽 설명 -> 상세 설명 순으로 내용을 전개한다.

비즈니스 현장에서 작성/관리되고 있는 문서들을 MECE 관점에서 살펴보면 그 분야의 전문가가 아닌 이상 문서의 내용을 이해하기가 힘들다. 해당 문서가 전문가 집단 내에서만 소용되는 문서라면 상관이 없겠지만 현재의 비즈니스 상황은 비전문가 또는 준전문가 집단을 대상으로 전문적인 내용에 대해 의사소통해야 하는 경우가 더 많다. 그렇다고 비전문가 대상의 의사소통이 필요한 경우에 그들을 대상으로 문서 작업을 따로 하는 것도 사실상 어려운 일이다. 그렇기에 처음부터 독자의 폭을 최대한 넓혀서 기획하고, 전체적인 맥락을 설명한 후 구체적으로설명하는 구조로 문서를 구성하여 문서의 효용성을 높여야 한다.

문장은 완전한 문장이어야 한다

Technical Writing에서 말하는 완전한 문장이란, 맥락을 짚어가야만 의미가 해석되고 이해되는 수준의 문장이 아니라, 그 자체만으로도 충분히 의미를 명확하게 나타낼 수 있는 문장을 의미한다. 추가적으로 해당 분야에 대한 지식이 없는 사람도 읽고 이해하는 데 무리가 없는 문장이여야 한다.

1. 국문법 측면에서 요구되는 문장 구성 요소가 빠지지 않고, 단어의 배열이 적절하여 문장의 의미가 명확해야 한다.

아래 문장은 예시이다.

강대국 프랑스는 베트남의 독립을 인정하지 않았고, 7년간의 전쟁으로 북위 17도 선을 경계로 하여 분단되었다.

읽기에 이상하지 않을 수 있으나 국문법 측면에서 확인하면 문제가 있는 문장이다. 문법적인 측면에서 마지막 서술어인 '분단되었다'의 주체는 프랑스이다. 즉 이 문장은 베트남이 아닌 프랑스를 분단시키게 되는 것임에도 불구하고 이미 우리는 이런 유형의 문장을 작성하며 이해하고 있다. 하지만 우리가 쓰는 모든 주제에 대해 독자가 이미 알고 있다고 전제할 수 없다. 만약 그럴 경우 구태여 문서를 작성할 이유가 없다. 우리가 비즈니스 분야의 글쓰기를 할 때는 해당 내용을 모르는 사람이 독자라는 전제를 두어야 한다. 내가 전달하고자 하는 내용을 정확하게 전달하려면 우선적으로 모든 술어의 주체가 문장에 반드시 드러나도록 문장을 작성해야 한다. 작성자 입장에서 너무나도 뻔한 주어이지만 문장에 꼭 반영하는 것을 원칙으로 삼아야 한다. 주어를 생략하면 문장의 주체와 대상이 명확하지 않아 문장의 의미가 애매해진다. 이런 경우 다국어로 번역 시 오역의 가능성이 높아진다.

문장 구성 요소들의 적절한 배열 역시 완전한 문장이기 위한 필수 요건이다.

아래 항목들은 예시이다.

• LAST_INPUT_TIME: 마지막으로 실행된 명령어 시간
• 시뮬레이션의 목적은 컴퓨터를 이용하여 실제로 제작 또는 실험하지 않고도 그 특성을 조사하는 데 있다.

위 항목들을 배열을 바꾼 예시이다.

• LAST_INPUT_TIME: 명령어가 마지막으로 실행된 시각
• 시뮬레이션의 목적은 실제로 제작 또는 실험하지 않고 컴퓨터를 이용하여 그 특성을 조사하는 데 있다.

바로 위 항목의 예시처럼 같은 단어를 이용해도 각 단어를 어떻게 배열하는지에 따라 문장의 품질이 달라진다. 단어 선택으로 인해 문장의 품질이 달라짐을 인식하여 내용을 정확하고 쉽게 설명할 수 있는 배열이 되도록 작성하고 검토해야 한다.

2. 구체적이고 명확한 의미의 용어를 사용해야 한다.

아래 문장은 예시이다.

이 명령어는 특정 cell의 Downlink Common Channel의 출력을 풀어버린다. 하나의 라우터가 하나 이상의 IP Routing Protocol을 돌리는 경우가 있다. Processor가 살았는지를 확인한다. 보드에 올라가는 S/W Application들을 구동한다. 입력된 신호에서 ATM Cell 경계를 잊어버린 경우에 발생한다.

만약 문장 작성자들에게 해당 용어의 의미에 대해 물어본다면, 아마 좀 더 구체적이고 명확한 의미의 용어들을 사용한 설명을 들을 수 있을 것이다. 작성자들이 상대를 이해시키기 위해 설명할 때 사용하는 용어로 명확한 문장을 적는다면 문장 품질이 한층 나아질 것이다.

일상적으로 우리가 사용하는 용어는 공식적인 문서에 사용하기에 부적합한 경우가 많다. 그러므로 글을 쓸 때는 해당 용어가 문장을 읽는 사람 모두가 명확하게 문장의 의미를 이해하는 데 무리가 없는지 확인해야 한다.

조사를 정확하게 사용하라

우리는 영어로 문장을 작성할 때 어떤 조사(전치사)를 사용할 지 고민을 많이 한다. 다른 나라 말이다 보니 그 쓰임새를 잘 몰라서 정확한 조사가 어떤 것인지를 놓고 고민을 하는 것 같다. 그런데 우리 나라 말로 문장을 작성할 때는 조사 사용에 있어 많은 고민 없이 편하게 사용하는 듯하다.

조사의 정확하지 않은 사용으로 인해 문장의 의미가 정확하게 전달되지 않는 경우가 의외로 많다. 문장의 의미를 아는 사람에게는 조사가 그냥 전체 의미에 묻혀서 별 기능이 없는 보조적인 용도로 인식되나 문장의 의미를 잘 이해하지 않아 문장을 꼼꼼하게 다시 읽고 있는 사람에게 조사의 기능은 아주 중요하다.

문맥에 따라 조사의 해석이 달라지는 경우가 많으므로 문장의 의미를 명확하게 하기 위해서는 조사를 정확하게 사용해야 한다.

예시로 아래 문장을 사용한다.

이 커넥터는 확장랙을 위한 커넥터로 사용되지 않는다.

위 문장은 애라와 같은 두 가지 의미로 해석될 수 있다.

1. 이 커넥터는 확장랙을 위한 커넥터로는 사용되지 않는다.
2. 이 커넥터는 확장락을 위한 커넥터로 현재 형상에서는 사용되지 않는다.

위와 같이 조사를 고쳐쓰면 의미가 정확하게 전달될 수 있다.

조사 '의'를 남용하지 않는다

관형격 조사 '의'의 사용을 줄이고 가능한 한 서술적으로 풀어 쓴다.

• 문자의 복사의 범위를 지정한다.(X)
• 복사할 문자의 범위를 지정한다.(O)

불필요한 '을/를'은 쓰지 않는다

• 소프트웨어 패키지를 설치를 한다.(X)
• 소프트웨어 패키지를 설치한다.(O)

불필요하게 조사를 겹쳐 쓰지 않는다

• 시스템으로부터의 메세지에 의해(X)
• 시스템에서 보낸 메세지에 의해(O)

원어나 표기된 단어 뒤에 쓰이는 조사는 앞말의 발음에 따라 표기한다

원어나 영어로 표기된 단어가 약어인 경우, 조사는 조사 바로 앞에 쓰인 로마자의 발음에 따라 표기한다.

• GAP은 -> GAP는(갭은 X -> 지에이피는 O)

원어나 영어로 표기된 단어가 약어가 아닌 경우, 조사는 해당 단어의 발음에 따라 표기한다.

• Ethernet는 -> Ethernet은(이더넷은)

명확한 의미의 용어를 사용하라/의미를 명확하게 표현하라

Technical Writing 관점에서 용어는 일물일어의 원칙을 지킬 것을 권장한다. 단지 체언 뿐 아니라 용언들도 그 의미를 명확하게 하고 통일하여 사용하는 것이 좋다. 그리고 무엇보다도 구체어에서 사용하는 편한 말들을 문서에 그대로 반영했을 경우에는 작성자의 의도가 독자에게 정확하게 전달되기 어렵다는 점을 감안해 용어 선택에 주의를 기울여야 한다.

예시로 아래 문장을 사용한다.

이 명령어는 특정 cell의 Downlink Common Channel의 출력을 풀어버린다.

위 문장에서의 '출력을 풀어버린다'라는 서술어의 의미가 명확하지 않다. 그럼으로써 해당 명령어의 기능을 정확하게 이해하기 힘들다. 이처럼 명확하지 않은 서술어의 사용으로 문서 내용에 대한 신뢰성을 잃는 일이 많으므로 주의해야 한다.

Technical Writing을 할 때 구체적이고 명확한 의미의 용어를 사용해야 한다.

• 틀리다 -> 다르다
  • 내부 블록에서 생성한 auto message는 UI에 접속된 CLI나 EMS에 따라 출력 Format을 틀리게 해서 출력한다.(X)
  • 내부 블록에서 생성한 auto message는 UI에 접속된 CLI나 EMS에 따라 출력 Format을 다르게 해서 출력한다.(O)
• 내리다 -> 전달/전송하다
  • User가 DSH를 통해 내리는 application 제어 요구는 DUL을 통하여 application에 반영된다.(X)
  • User가 DSH를 통해 전송하는 application 제어 요구는 DUL을 통하여 application에 반영된다.(O)
• 내리다 -> 입력하다
  • 운용자가 CLI나 EMS를 통해서 명령어를 내리면 이 명령어를 UI가 받아서 SGSN TP의 내부 블록으로 전송하고, 수행 결과를 CLI나 EMS로 전송한다.(X)
  • 운용자가 CLI나 EMS를 통해서 명령어를 입력하면 이 명령어를 UI가 받아서 SGSN TP의 내부 블록으로 전송하고, 수행 결과를 CLI나 EMS로 전송한다.(O)
• 들어간다 -> 실행한다
  • configure 모드에서 'interface anc_0'로 들어간다.(X)
  • configure 모드에서 'interface anc_0'를 실행한다.(O)
• 통해 -> 사용하여
  • ACR이 수집한 과금 정보는 Diameter 프로토콜을 통해 AAA 서버에 전달된다.(X)
  • ACR이 수집한 과금 정보는 Diameter 프로토콜을 사용하여 AAA 서버에 전달된다.(O)
• 깨어나다 -> 다시 사용하다
  • 이 모드에서 시스템이 꺼져 있는 것과 유사한 전력을 소비합니다. 깨어나려면 전원 버튼을 누릅니다.(X)
  • 이 모드에서 시스템이 꺼져 있는 것과 유사한 전력을 소비합니다. 다시 사용하려면 전원 버튼을 누릅니다.(O)

약어를 제대로 사용하라

자신의 분야에서 사용하는 약어를 다른 분야에서는 다른 의미로 사용하고 있는 경험을 한 적이 있을 것이다. 간단한 예로 일상에서 사용하는 현금자동지급기를 ATM이라고 한다. ATM은 Automatic Teller Machine의 약어이다. 정보통신 분야에서 ATM은 비동기 전송모드를 의미하는 Asynchronous Transfer Mode의 약어로 사용되고 있다. 약어가 동일안 의미로 해석되기를 기대할 수 없어 비즈니스 현장에서 사용하는 약어는 정확하게 정의하는 절차가 필수이다.

먼저 약어란 단어 및 용어를 원래의 어형보다 간략하게 단축하여 표기한 것이다. 약어는 반복하여 사용되는 긴 용어를 경제적으로 표현할 수 있도록 하기 때문에 일반적으로 많이 사용되고 있다. 약어는 문서에서 처음 등장할 때 한 번 풀어서 설명하고, 이후부터는 약어만 사용하는 것이 기본이다.

약어를 만들 때 기준으로 삼을 수 있는 몇 가지 원칙이다.

대원칙

​ 약어에서 사용된 단어의 첫 글자는 대문자로 표기한다.

보조 원칙 1

​ 약어 내의 두 글자 이상이 한 단어에서 추출된 것일 때에도 단어의 첫 글자만 대문자로 표기한다.

보조 원칙 2

​ 약어에 사용되지 않은 단어는 소문자로 표기한다.

보조 원칙 3

​ 약어에서 소문자로 사용된 단어는 풀이에서도 소문자로 표기한다.

보조 원칙 4

​ 약어 내에 다른 약어가 포함된 경우에는 풀어서 표기한다.

보조 원칙 5

​ 약어 내에 다른 약어의 일부가 포함된 경우에는 약어로 표기한다.

보조 원칙 6

​ 약어에 있는 숫자/특수문자는 풀이에서도 숫자/특수문자로 표기한다.

일반적으로 약어는 대문자로 표기하나 기술문서를 보다 보면 분명 약어임에도 불구하고 소문자로 표기한 경우가 많다. 기본/원칙을 아는 것 이상으로 기본/원칙을 지키는 것이 중요하다.

띄어쓰기를 정확하게 하라

일상에서 띄어쓰기 정도는 틀려도 별 상관없다고 생각하고 있다. 띄어쓰기가 틀려도 내 글을 읽는 사람은 내가 말하려고 하는 것이 무엇인지 이해할 것이라고 생각하는 것이다.

띄어쓰기 관련해서는 한글 맞춤법 제1장 총칙의 제2항에 "문장의 각 단어는 띄어 씀을 원칙으로 한다"라고 반영되어 있다. 아래는 관련있는 제5장의 내용들이다.

• 제41항

  • 조사는 그 앞말에 붙여 쓴다.

• 제42항

  • 의존 명사는 띄어 쓴다.

• 제43항

  • 단위를 나타내는 명사는 띄어 쓴다. 다만, 순서를 나타내는 경우나 숫자가 어울리어 쓰이는 경우에는 붙여 쓸 수 있다.

• 제44항

  • 수를 적을 적에는 만 단위로 띄어 쓴다.

• 제45항

  • 두 말을 이어주거나 열거할 적에 쓰이는 말들은 띄어 쓴다.

• 제46항

  • 단음절로 된 단어가 연이어 나타날 적에는 붙여 쓸 수 있다.

• 제47항

  • 보조 용언은 띄어 씀을 원칙으로 하되, 경우에 따라 붙여 씀도 허용한다.

• 제48항

  • 성과 이름, 성과 호등은 붙여 쓰고, 이에 덧붙는 호칭어, 관직명 등은 띄어 쓴다. 다만, 성과 이름, 성과 호를 분명히 구분할 필요가 있을 경우에는 띄어 쓸 수 있다.

• 제49항

  • 성명 이외의 고유 명사는 단어별로 띄어 씀을 원칙으로 하되, 붙여 쓸 수 있다.

띄어쓰기는 명료해 보이나 그렇지 않은 이유가 띄어쓰기의 기본 단위인 '단어'의 개념 자체가 모호하기 때문이다.

아래는 자주 틀리는 띄어쓰기에 대한 정리이다.

'별'의 띄어쓰기

1. 별: 관형사, 띄어 쓴다. 의미: 보통과 다르게 두드러지거나 특별한. 예: 그와 나는 별 사이가 아니다. 별 부담없이 나의 생각을 말해 주었다.
2. 별: 접미사, 붙여 쓴다. 의미: (일부 명사 뒤에 붙어) '그것에 따른'의 뜻. 예: 능력별, 성별, 월별, 학년별.

'상'의 띄어쓰기

1. 상: 접미사, 붙여 쓴다. 의미: (일부 명사 뒤에 붙어) '그것과 관계된 입장'의 뜻. 예: 관계상, 미관상, 사실상, 절차상.
2. 상: 접미사, 붙여 쓴다. 의미: (일부 명사 뒤에 붙어) '구체적인 또는 추상적인 공간에서의 한 위치'의 뜻. 예: 인터넷상, 전설상.
3. 상: 접미사, 붙여 쓴다. 의미: (일부 명사 뒤에 붙어) '모양' 또는 '상태'의 뜻. 예: 나선상, 계단상, 원반상, 포도상.

'데'의 띄어쓰기

1. 명사 또는 의존 명사, 띄어 쓴다. 의미: '곳'이나 장소, '일'이나 '것', '경우'등의 뜻. 예: 올 데 갈 데 없는 사람, 재시작하든 데 걸리는 시간, 머리 아픈 데 먹는 약.
2. 어미, 붙여 쓴다. 의미: 과거 어느 때에 직접 경험하여 알게 된 사실을 현재의 말하는 장면에 그대로 옮겨와서 말함을 나타냄. 예: 그 친구는 아들만 둘이데.

'못'의 띄어쓰기

1. 부사, 띄어 쓴다. 의미: (주로 동사 앞에 쓰여) 동사가 나타내는 동작을 할 수 없다거나 상태가 이루어지지 않았다는 부정의 뜻을 나타내는 말. 예: 초등학교도 못 마치다, 아무도 못 말린다, 금구에서 전주까지는 사십 리가 못 되었다.
2. '못'이 '되다'와 결합하여 품행이 좋지 않거나 일이 뜻대로 되지 않음을 나타낼 때는 한 단어로 붙여 쓴다.(못된 짓 등)
3. 합성어로 굳어진 '못하다'는 한 단어로서 붙여 쓴다.(술을 못하다, 아름답지 못하다, 못해도 열 그루는 되었다 등)

'안'의 띄어쓰기

1. 부사, 띄어 쓴다. 의미: '아니'의 준말. 예: 비가 안 온다, 안 먹고는 살 수 없다.
2. '안'이 '되다'와 결합하여 일이 좋게 이루어지지 않거나 사람이 훌륭하게 되지 못함을 나타낼 때는 한 단어로서 붙여 쓴다.(잘 안된다 등)

'부'의 띄어쓰기

1. '부분'이나, '부문'의 뜻을 더하는 접미사, 붙여 쓴다. 예: 중심부, 입력부, 상단부.
2. '업무 부서'의 뜻을 더하는 접미사 붙여 쓴다. 예: 인사부, 출판부, 홍보부.

'괄호'의 띄어쓰기

괄호는 국문 문서에서는 앞 말에 붙여 쓰고, 영문 문서에서는 띄어 쓴다.

예: 니체(독일의 철학자)는 이렇게 말했다.

Nietzsche (German Philosopher) said.

'전문어'/'고유어'의 띄어쓰기

전문어와 고유 명사는 모두 단어별로 띄어 쓰는 것이 원칙이지만 전문어는 붙일 수 있고 고유 명사는 '단위'별로 띄어 쓸 수 있다.

예: 서울 대학교 의과 대학 부속 병원 -> 서울대학교 의과대학 부속병원

'수'의 띄어쓰기

만 단위로 띄어 쓴다.

예: 45 -> 마흔다섯

'외래어'의 띄어쓰기

원어의 띄어쓰기에 따라 띄어 쓴다. 하지만 원어에는 띄어 썼으나 관용상 붙여 쓰는 것들이 있다.(아이스크림, 홈런, 골인 등)
음운론적 융합이 일어난 경우에도 띄어 쓰지 않는다.(애드벌룬, 에어컨 등)

문장 부호를 제대로 사용하라

우리가 쓰고 있는 모든 문장에는 문장 부호가 들어간다. 울리는 여러 가지 문장 부호를 활용하여 문장을 작성하고 있으나 그 용법에 대한 정확한 규정을 몰라 나름대로의 원칙을 만들어서 사용하는 경우가 많다. 우리 어문 규정에서 문장 부호의 용법을 자세히 설명하지 않고 있는 것도 우리가 정확한 문장 부호 사용 기준을 갖고 있지 못한 원인 중 하나라고 할 수 있다.

아래는 문장 부호의 중요성에 관한 예시이다.

이 커넥터는 확장랙을 위한 커넥터로 사용되지 않는다. This connector is not used for extension rack.

이 커넥터는 확장랙을 위한 커넥터로, 사용되지 않는다. This connector is for extension rack, but not used at this configuration.

마침표

어문 규정에서 정의하고 있는 마침표에는 온점(.), 물음표(?), 느낌표(!)가 있다. 일반적으로 서술형 문장의 끝에 쓰는 마침표는 온점이라고 한다.

온점의 쓰임

• 서술, 명령, 청유 등을 나타내는 문장의 끝에 쓴다. 단, 표제어나 표어에는 쓰지 않는다. 그러므로, 문서에 반영된 제목이나 전자우편의 제목이 문장 형식인 경우에는 온점을 쓰지 않음에 유의해야 한다.
• 아라비아 숫자만으로 연월일을 표시할 적에 쓴다.
  • 예: 1919. 3. 1.
• 표시 문자 다음에 쓴다.
  • 예: 1. 가.
• 준말을 나타내는 데 쓴다.
  • 예: 서. 1997. 3. 5.

쉼표

어문 규정에서 정의하고 있는 쉼표에는 반점(,), 가운뎃점(·), 쌍점(:), 빗금(/)이 있다. 반점은 문장에서 호흡상 쉬면 좋은 곳이나 문법상 필요한 곳에 쓴다. 가운뎃점은 열거된 여러 단위가 대등하거나 밀접한 관계임을 나타낼 때 쓴다. 쌍점은 내포되어있는 종류를 나열할 때 쓰고, 빗금은 대응 · 대립 되거나 대등한 것을 보여줄 때, 분수를 나타낼 때 쓴다.

반점의 쓰임

어문 규정에서는 반점을 다음의 경우에 사용하는 것으로 정의한다.

반점 쓰임	예문
같은 자격의 어구가 열거될 때	근면, 검소, 협동은 우리 겨레의 미덕이다.
짝을 지어 구별할 필요가 있을 때	닭과 지네, 고양이와 개는 상극이다.
바로 다음의 말을 꾸미지 않을 때	성질 급한, 철수의 누이동생이 화를 냈다.
대등하거나 종속적인 절이 이어질 때에 절 사이에	콩 심으면 콩나고, 팥 심으면 팥 난다.
부르는 말이나 다댑하는 말 뒤에	예, 지금 가겠습니다.
제시어 다음에	용기, 이것이야말로 무엇과도 바꿀 수 없는 젊은이의 자산이다.
도치된 문장에	이리 오세요, 어머님.
가벼운 감탄을 나타내는 말 뒤에	아, 깜빡 잊었구나.
문장 첫 머리의 접속이나 연결을 나타내는 말 다음에, 단 일반적으로 쓰이는 접속사(그러나, 그러므로, 그리고, 그런데 등) 뒤에는 쓰지 않음	첫째, 몸이 튼튼해야 된다. 아무튼, 나는 집으로 돌아가겠다.
문장 중간에 끼어든 구절 앞뒤에	나는 솔직히 말하면, 그 말이 별로 탐탁하지 않소.
되풀이를 피하기 위하여 한 부분을 줄일 때	여름에는 바다에서, 겨울에는 산에서 휴가를 즐겼다.
문맥상 끊어 읽어야 할 곳에	갑돌이가 울면서, 떠나는 갑순이를 배웅했다. 갑돌이가, 울면서 떠나는 갑순이를 배웅했다.
숫자를 나열할 때	1, 2, 3, 4
수의 폭이나 개락을 나타낼 때	5, 6개
수의 자릿점을 나타낼 때	14,314

가운뎃점의 쓰임

어문 규정에서는 가운뎃점을 다음의 경우 사용하는 것으로 정의한다.

가운뎃점 쓰임	예문
쉼표로 열거된 어구가 다시 여러 단위로 나누어질 때	시장에 가서 사과 · 배 · 복숭아, 고추 · 마늘 · 파, 조기 · 명태 · 고등어를 샀다.
특정한 의미를 가지는 날을 나타내는 숫자 표현에	3 · 1 운동, 8 · 15 광복
같은 계열의 단어 사이에	동사 · 형용사를 합하여 용언이라고 한다.

쌍점의 쓰임

어문 규정에서는 쌍점을 다음의 경우 사용하는 것으로 정의한다.

쌍점 쓰임	예문
내포되어 있는 종류를 들 때	문장 부호: 마침표, 쉼표, 괄호 등
소표제 뒤에 간단한 설명이 붙을 때	일시: 1984년 10월 15일 10시
저자명 다음에 저서명을 적을 때	정약용: 목민심서, 경세유표
시와 분, 장과 절 따위를 구별할 때	오전 10:20, 요한 3:16
둘 이상을 대비할 때	65 : 60

빗금의 쓰임

어문 규정에서는 빗음을 다음의 경우 사용하는 것으로 정의한다.

빗금 쓰임	예문
대립되거나 대등한 것을 함께 보이는 단어와 구, 절 사이에	착한 사람/악한 사람, 백이십오 원/125원
분수를 나타낼 때	3/4분기

괄호

어문 규정에서는 괄호를 묶음표라고 하며, 괄호에는 소괄호, 중괄호, 대괄호가 있다. 각 괄호의 기호 및 쓰임은 아래 표와 같다.

종류	기호	쓰임	예시
소괄호	()	- 원어, 연대, 주석, 설명 등을 넣을 때 - 기호 또는 기호적인 구실을 하는 문자, 단어, 구에 사용 - 빈 자리임을 나타낼 때	- 니체(독일의 철학자) - 정답: (1) 주어 - 우리나라의 수도는 ( )이다.
중괄호	{}	- 여러 단위를 동등하게 묶어서 보일 때	- 주격 조사 {이, 가} - 국가의 3요소 {국토, 국민, 주권}
대괄호	[]	- 괄호 안의 말이 바깥 말과 음이 다를 때 - 괄호 안에 또 괄호가 있을 때	- 낱말[單語] - 명령에 있어서 불확실[단호(斷乎)하지 못함]은 복종에 있어 불확실[모호(模糊)함]을 낳는다.

따옴표

따옴표는 인용하여 쓰는 말이나 글을 다른 것과 구별하기 위해 앞뒤에 찍는 부호이며, 큰 따옴표와 작은 따옴표로 구분된다.

종류	기호	쓰임	예
큰따옴표	" "	- 대화, 인용, 특별 어구 등	- "전기가 없었을 때는 어떻게 책을 보았을까?" - 예로부터 "민심은 천심이다."라고 하였다.
작은따옴표	' '	- 인용문 안에 인용문이 들어가는 경우 - 마음 속으로 한 말을 적을 때 - 드러냄표 대신 사용	- "여러분! 침착해야 합니다. '하늘이 무너져도 솟아날 구멍이 있다.'고 합니다." - '만약 내가 이런 모습으로 돌아간다면 모두들 깜짝 놀라겠지.' - 지금 내가 필요한 것은 '지식'이 아니라 '실천'입니다.

수십 명이 작성했지만 한 사람이 작성한 느낌을 주도록 작성하라

조직 내에서 문서는 일반적으로 여러 사람이 같은 주제에 대해서 다른 내용으로 작성하거나(각 업무 단위 별 주기적인 업무 보고서 등) 여러 주제에 대해서 각각의 전문가들이 작성한 내용을 취합하여 하나의 문서로 작성할 때가 많다. 이러한 경우 항상 선행하는 것이 템플릿, 즉 문서 양식을 먼저 정하여 공유하는 것이다. 이것이 일차원적인 업무 매뉴얼이라고 할 수 있다.

우리가 문서 작업을 할 때 업무 매뉴얼을 먼저 고려하는 이유가 뭘까? 작성자들이 쉽게 문서 작성에 접근하게 하는 수단일 수도 있겠지만 궁극적으로는 독자가 혼란스럽지 않게 어떤 일관성을 유지하기 위함이다.

이렇듯 우리가 문서를 작성할 때 그것을 인지하건 아니건 항상 독자에 대한 배려가 그 속성의 바닥에 깔려 있는 것이다. 업무 매뉴얼을 작성할 때는 아래 항목들의 반영 여부를 검토하고 실행할 필요가 있다.

• 문서의 개념: 문서의 의미 및 작성 목적을 정의
• 내용의 범위: 작성 목적에 맞는 내용의 범위 결정
• 작성 프로세스: 다른 문서와의 연관 관계, 참고 자료 등 정리
• 작성 방법: 각 항목별 작성 방법 정리
• 검토 프로세스: 작성한 문서의 내용을 검토하는 주체와 주요 검토 내용 정리
• 문서 작성 업무의 관리 포인트를 바꿔라

조직에서 관리자가 하는 역할은 조직 구성원들이 본연의 역할을 충실히 수행할 수 있도록 자원을 유지/관리하는 일이다. 그래서 부족한 것은 보완할 수 있는 방법을 찾고, 넘치는 부분이 있으면 자원 재분배를 통해서 조직의 역량을 키우는 방안을 마련해야 한다.

이러한 관리 역할에 대해 한번 되짚어볼 점이 있다면, 지금 우리는 Exist/Not Exist(있다/없다)에 대한 관리 또는 Did/Didn't(했다/안 했다)에 대한 관리를 해오고 있다는 것이다. 조직의 업이 정해지고 프로세스가 정립된 후, 정해진 프로세스대로 일이 진행되어 최종 결과물이 나오면 관리자는 그 결과물의 유무(있다/없다)를 관리한다.

하지만 관리자가 궁극적으로 관리해야 하는 포인트는 결과물의 존재 유무나 실행 여부가 아니라 그 결과물의 가치이다.

업무 프로세스상에서 결과물이 문서인 경우에는 해당 문서의 작성 목적에 맞는 내용이 충분하고도 정확하게 작성 되었는지를 철저하게 제어할 수 있어야 한다. 여러 업무 환경에서 불거져 나오는 문제점을 들어보면 문서가 작성은 되었으나

• 찾는 내용이 없거나 정확하지 않다.
• 내용에 반영이 되어 있긴 한데, 무엇을 말하고 있는지 이해할 수 없다.
• 연관 있는 다른 문서와 내용이 다르게 기술되어 있다.

등등 일은 하고 있으나 가치 없는 일을 형식적으로 하는 형태인 것으로 파악된다.

그러므로 각 단위 조직에서는 문서의 품질을 확보할 수 있는, 그래서 문서를 작성하는 일이 시간을 허비하는 일이 아니라 가치를 창출하는 일이 될 수 있도록 프로세스를 포완하는 작업을 시급히 추진해야 한다.

Technical Writing Tips

완벽한 문장이란

어린 왕자의 저자 생텍쥐페리는 "완벽함이란 더 이상 더할 것이 없는 상태가 아니라, 더 이상 뺄 것이 없는 상태"라고 했다. 글쓰기에서도 이 말을 되새길 필요가 있다. 일반적으로 Business Writing의 한 원칙으로 제시하고 있는 "짧게 써라"가 바로 생텍쥐페리가 말하는 완벽함과 관계가 있다.

Technical Writing에서 완벽한 문장이란 간결성 · 정확성 · 명확성을 갖추고 있으면서 독자가 이해하기 쉬운 문장 이라고 할 수 있다. 문장에 있어서 정답은 사람마다 다르겠지만 이 책 저자가 정의한 정답은 재현성이다. 적은 문장을 읽은 모든 사람이 똑같은 의미로 해석한다면 정답이라는 것이다.

Technical Writing에서는 짧게 쓰기 전에 반드시 충족시켜야 할 조건이 있다. 문장의 필수 구성 요소를 빼지 말아야 한다는 점이다. 글쓰기의 근본 목적은 소통이므로 상대가 오해 없이 소통하기 위해서는 상대에게 먹히는 글이어야 한다. 문장의 필수 구성 요소인 주어, 목적어, 서술어 등이 문장에 반드시 포함되어 있어야 의미가 명확한 문장일 수 있고, 상대에게 의미를 정확하게 전달할 수 있다.

문장을 간결하게 쓰기 위해서는 다음의 요소들을 문장에 반영해야 한다.

• 한 문장에는 하나의 메세지만 담는다.
• 형용사와 부사의 사용을 절제한다.
• 중복된 의미의 표현을 과감하게 없앤다.

표는 어떻게 작성하는가

Technical Writing에서 가장 많이 사용하는 비주얼 요소는 표다. 표는 많은 양의 정보를 적은 공간에 간결하게 나타내고자 할 때 사용한다. 표는 복잡한 내용을 알기 쉽게 정리하는 데 효과적이다. 표는 관련 내용을 포함하고 있는 문단 아래에 두는 것이 좋다.

표를 활용할 때 정보의 전달성 측면에서 효율성을 검토해야 한다. 표를 구성하는 요소들과 그 작성법을 정리함으로써 표 작성과 이해에 도움을 주고자 한다. 표는 표 번호, 표 제목, 세로선, 가로선, 세로 항목, 가로 항목, 보충 설명의 7개 요소로 구성된다.

<표 1> 표의 구성 요소

세로 헤딩(Column Heading)	세로 헤딩(Column Heading)	세로 헤딩(Column Heading)
가로 헤딩(Line Heading)	표 본문	표 본문
가로 헤딩(Line Heading)	표 본문	표 본문
가로 헤딩(Line Heading)	표 본문	내용 없음(None)

표 번호와 표 제목

표 번호와 표 제목은 표 윗줄의 가운데에 정렬한다.(이 문서는 마크다운 문법으로 작성되었으므로 생략) 분량이 적은 자료의 표 번호는 순번으로 표기하고, 분량이 많거나 장으로 구분된 자료의 표 벊는 각 장에서의 순법으로 표기한다. 하나의 표가 여러 페이지에 걸쳐 기술될 때는 표 번호와 표 제목을 각 페이지의 맨 위에 반복하며, 표의 세로 헤딩에도 반복하여 반영한다.

표 제목은 독자가 제목만 봐도 표 내용의 주체를 알 수 있을 만큼 구체적인 것으로 한다.

세로선

표 양 끝의 세로선은 긋지 않는 것이 보기 좋으며, 세로선의 굵기는 0.05 ~ 0.1mm가 보기 좋다.

가로선

가로선은 최소한으로 긋는 것이 보기 좋으며 세로 헤딩과 표 본문을 구분하는 가로선만 굵게(0.2 ~ 0.3) 하고, 그 이외의 가로선은 세로선과 같은 굵기로 하면 보기 좋다.

표 본문

각 항목의 글자 크기는 문서의 본문 글자보다 작게 한다. 표 본문에서 문자는 왼쪽 또는 중앙으로 정렬하고 숫자는 소수점을 기준으로 정렬한다. 각 단위는 각 헤딩에 괄호 형태로 표시한다. 그리고 표에서 데이터가 없는 셀에는 반드시 '내용 없음'으로 표기하여 해당 셀에는 내용이 없다는 것을 명확하게 나타내어야 한다. 그래야 독자가 내용 누락에 대한 의심을 거둘 수 있다.

보충 설명

표에 기술하고 있는 내용을 보충 설명하며, 글자 크기는 표 본문보다 작게 한다.

헷갈리는 표현

'와/과'와 '및'

'와/과'는 앞말과 뒷말이 대등할 때 쓰나, '및'은 앞말이 뒷말의 중심이 될 때 쓴다.

'~로', '~로서', '~로써'

• ~로: 방향, 원인, 재료, 신분, 시간 등을 나타내는 부사격 조사
• ~로서: '지위나 신분 또는 자격을 가지고'의 뜻을 나타내는 부사격 조사
• ~로써: '~을 가지고'의 뜻을 나타내는 부사격 조사

전파 간섭이 '크다/작다'와 '많다/적다' -> '많다/적다''

전파간섭은 '한정된 주파수 대역 때문에 인접한 주파수대역 사이에 발생하는 부정적 현상'을 말한다. 이러한 현상의 정도나 빈도를 말할 때에는 '많다/적다'로 말하는 것이 '크다/작다'를 사용하는 것보다는 더 자연스럽다.

'동작'과 '작동'

동작은 '몸이나 손발 따위를 움직임, 또는 그런 모양'이란 뜻이고, 작동은 '기계 따위가 작용을 받아 움직임, 또는 기계 따위를 움직이게 함'이라는 뜻이다. 그러므로 그 의미를 명확하게 구분하여 장비나 시스템의 기능을 설명할 때는 '작동'으로 표현하는 것이 바람직하다.

'작다'와 '적다'

'적다'는 분량, 수효 등 양과 관계된 것으로 반대말이 '많다'이며, '작다'는 길이/부피/규모 등 크기와 관계된 것으로 반대말이 '크다'이다.

'~율'과 '~률'

'율'은 모음과 'ㄴ' 받침 뒤에서 쓰고, 그 외의 경우에는 '률'을 쓴다.

• 비율, 부하율, 실패율, 일치율, 백분율, 제한율, 회신율
• 등록률, 사용률, 성공률, 성장률, 응답률, 출석률, 전송률

'시간'과 '시각'

일반적으로 구분하지 않고 시간으로 많이 쓰고 있지만 각각의 정확한 의미는 다음과 같다.

• 시간: 어떤 시각에서 어떤 시각까지의 사이
• 시각: 시간의 어느 한 지점

'되'와 '돼'

'돼'는 '되어'의 줄임말이다. 따라서 '되어'로 고칠 수 있으면 '돼', 아니라면 '되'로 쓴다.

'결재'와 '결제'

결재는 결정할 권한이 있는 상관이 부하가 제출한 안건을 검토하여 허가하거나 승인하는 것을 말한다. 반면 결제는 어음이나 대금 따위를 주고받아서 매매 당사자 사이의 거래 관계를 끝맺는 행위를 말한다. 그러므로 직장생활을 하면서 기획서나 보고서에 대해서 상사의 승인을 요청하는 경우 '결재'로 써야 한다.

단위 표기 가이드

문서를 작성할 때 단위를 표기할 경우가 많은데, 단위는 SI(The international System of Units) 표준에 따라 사용한다.

참고문헌 및 인용자료

국립 국어원 홈페이지

Gerald J. Alred, The professional Writer: A Guide for Advanced Technical Writing.

William Strunk, Jr. Allyn & Bacon, The Element of Style.