Technical Communication 정보
Saltlux
목차 |
전문 분야로서의 테크니컬 라이팅
‘테크니컬 라이터’라는 용어는 오랫동안 쓰여 왔지만 그 의미는 빠르게 변하고 있습니다. 한 때 이 용어는 소프트웨어 프로그램을 해부해서 사용자가 쉽게 사용할 수 있는 수준의 지시서로 만드는, 컴퓨터 마니아가 사진을 깜짝할 사이에 나타내게 하는 용어로 사용되었습니다.
오늘날이 기술은 생활과 업무에 여러모로 얽혀있기 때문에, 기술을 이해하고 이 기술에 대해 서술할 수 있는 전문가에 대한 필요성이 날로 증가하고 있다.
예를 들어, 기술 분야의 전문 구인구직 사이트인 DICE(www.dice.com)에서 ‘writer’라는 키워드 검색에 대한 결과로 768개의 직업을 소개하고 있습니다. 처음 세 가지는 상당히 전형적인 계약직 테크니컬 라이터이고, 네 번째는 항공 분야 라이터입니다. 리스트를 보면 Business Analyst, Tech Business Writer, Training Writer, 심지어는 Senior Creative Writer라는 종류의 테크니컬 라이터도 필요로 합니다.
이들 중 많은 직업군은 RoboHelp 및 ReportWriter와 같은 특수 프로그램에 대한 숙달을 요구하기도 하며, 경우에 따라서는 단순히 웹 상에서나 인쇄물로 의사 소통을 확실히 하는 것만을 요구하기도 합니다.
그러면 우리의 재능을 어떻게 테크니컬 라이팅 분야로 옮겨갈 수 있을까요? 우리가 알고 있는 것을 더 넓게 생각하는 것으로부터 시작할 수 있습니다. 내가 지금 작업하고 있는 것에서 시작하여 내가 할 수 있다고 확신하는 것에 이르기까지 리스트를 만듭니다. 내가 잘 이용할 수 있는 컴퓨터 프로그램과 같이 확실한 것들을 추가합니다. 웹 상에서 조사한 것은 빅세일에서 발견할 수 있는 것일지라도 간과하지 않아야 합니다. 아마도 우리가 사용하고 있는 휴대전화의 모든 기능을 실제로 완전히 이해하고 사용할 수 있다면 그것으로도 큰 장점이 될 수 있습니다.
우리 자신이 테크니컬 라이팅에 적절한 재주를 갖고 있는 것이 발견된다면 지금이 바로 테크니컬 라이팅이라는 직업에 안착할 때인 것입니다.
글을 잘 쓰고 자주 쓰면 테크니컬 라이터가 되는 길은 그리 멀지 않습니다.
출처: About.com freelance writer’s newsletter, Anne Wayman
훌륭한 저술을 위한 10가지 방법
훌륭한 저술은 문법적 용어의 확고한 이해와 작문의 법칙에 달려있습니다. 아래에 있는 단순한 10가지 법칙이 저술을 훌륭하게 만드는데 도움을 줄 것입니다.
1. 우아하게 쓰려고 하지 말고 간략하게 쓸 것.
2. 이상한 단어 대신 친숙한 단어를 쓸 것.
3. 소설적인 스타일보다 일상적인 스타일로 쓸 것. 소설을 쓰지 않는다면 될수록 글을 짧게 쓸 것.
4. 형용사나 부사 대신 명사나 동사를 쓸 것. 명확하게 쓸 것.
5. 영상 명사와 행동 동사를 쓸 것.
6. 짧은 단어로 충분하다면 긴 단어는 절대 쓰지 말 것.
7. 단순한 은유법에 숙달할 것.
8. 복합 문장보다 단순 문장을 쓸 것.
9. 문장의 길이를 다양하게 할 것.
10. 되도록이면 능동태를 쓸 것.
출처: About.com freelance writer’s newsletter, D. Roberts
자기 목소리를 잘 내기 위한 5가지 조건
다른 모든 작가로부터 구별되는 것은 결국 자기 의견을 잘 쓰는 것입니다. 조사를 완료하고 등장 인물을 개발하는 것도 중요하지만 사실이나 광경을 종이에 옮겨 놓는 것은 자신의 목소리(의견)를 반영하는 것입니다. 이것이 당신으로 하여금 ‘10가지 닭고기 요리법’이란 제목으로 글을 쓸 수 있게 하는 이유이며 똑같은 제목으로 심지어는 똑같은 재료를 갖고서 누구라도 글을 쓸 수 있지만 그 결과물은 다를 수 있는 이유입니다. 각각의 글은 우리 각 개인의 경험을 통해서 걸러지며 우리 각자의 의견 속에 자리잡게 됩니다. 즉, 많은 미스터리물에서는 대략적으로 그 구성이 비슷하기는 하지만 각각의 글은 서로 다르게 표현됩니다. 소설에서는 개개인의 작가가 자기만의 독특한 의견을 갖고 있을 뿐만 아니라 각 등장 인물을 위한 목소리를 개발합니다.
Dictionary.com에서 목소리(Voice)라는 단어를 다음과 같이 정의하고 있습니다. "책을 통해 작가나 등장 인물이 표현하고자 하는 확실한 스타일이나 태도(The distinctive style or manner of expression of an author or of a character in a book)." 그러면 우리 스스로의 의견은 어떻게 개발해야 할까요? 아래에 다섯 가지 조건이 적혀 있습니다.
1. 솔직하게, 그리고 가슴으로 써라. (Write honestly, from the heart.)
느낌으로 글을 쓰면 의견은 따라서 써지게 된다. 물론, 다시 쓰기도 하고 편집도 하겠지만 느낌이 표면에 나타나도록 하라.
2. 친구에게 글을 쓰거나 말하듯이 써라. (Write as if you were writing or talking to a friend.)
친구에게 글을 쓸 때는 정직성과 정열이 나타나게 마련이다. 고로 명쾌하게 하라. 단순할지라도 명쾌함은 노래하듯이 글쓰기를 할 수 있다는 것을 나타낸다.
3. 독자를 마음 속으로 그려보라. (Picture your reader.)
글을 쓰는 것은 매번 특별한 독자를 위해 쓰는 것이다. 하나하나의 독자가 모두 친구라 생각하고 그들에게 글을 쓴다고 생각하라.
4. 광범위한 독서를 하라. (Read widely.)
독서를 가려서 하지 말라. 자신의 흥미 분야에서 빠져 나와서 마음에 내키지 않는 것들도 읽으면서 그 목소리에 귀를 기울여라. 자신도 그렇게 글을 쓰는지 생각해 보라. 그렇지 않다면 왜 아닌지 생각해 보라. 대답이 무엇이건 간에 중요한 것은 작가의 목소리(Voice)를 알게 된다는 것이다.
5. 실험하라. (Experiment)
편안한 것을 깨고 나와라. 항상 기사나 논설만을 쓰는 사람은 단편 소설이나 그 일부라도 써보라. 대부분 나이든 사람들을 위한 여행 잡지 기사를 주로 쓰는 사람은 어린이를 위해서도 글을 써보라. 이 실험의 목표는 새로운 시장의 개척이 아니라 경험에 의해서 자신의 영역을 넓히는데 있다. 연습으로 한두 문장으로도 해볼 수 있다.
여러 가지 면에서 목소리(Voice)를 적는 것은 자동적이지만 개선하고 확대시키면 융통성과 소재를 더욱 좋게 개발할 수 있다는 의미가 있습니다.
자주 잘 쓰는 것이 좋은 글을 쓰는 비결입니다.
출처: About.com freelance writer’s newsletter, Anne Wayman
글쓰기 연습이 효과를 발휘하는 11가지 이유
글쓰기 연습은 기분을 좋게 합니다.
글쓰기 연습! 이 단어는 바벨과 땀을 생각나게 합니다. 운동 연습이 몸을 좋게 하기 위해서 설계된 것과 같이 글쓰기 연습은 글쓰기를 좋게 하기 위해 계획하는 것입니다. 글쓰기 연습은 작업하는 것 같아서 자칫 무미건조하고 지루해질 수도 있습니다. 글쓰기를 좋아할 수 있는 이유들을 아래에 나열해 보았습니다.
1. 글쓰기를 시작하는 방법을 알려 준다.
2. 스스로 하는 것이기 때문에 희망을 부풀게 해준다.
3. 철자법, 문법, 구두점 등을 걱정 안해도 된다.
4. 프로젝트에 열중하다가 연습을 하면 새로운 기분이 된다.
5. 글쓰기 연습은 내면의 소리와 만날 수 있게 해준다.
6. 가끔은 전혀 새로운 목소리와 만나게 해준다.
7. 쓰기에 실패하는 때에도 뭔가 쓴다는 것으로 자위할 수 있다.
8. 살찌게 하지도 않을 뿐 아니라 만족도도 오래도록 남는다.
9. 글쓰기 연습은 이것이 아니면 경험할 수 없고 무엇인가 하고 있다는 도전 의식을 가져다 준다.
10. 글쓰기 연습은 일기 식으로 쓸 수가 있는데 일기장은 휴대할 수 있다.
11. 집 밖에서 컴퓨터와 떨어져서 작업할 수 있다.
글쓰기 연습은 짧아서 10분에서 15분 이상의 시간이 필요하지 않고 작업 중인 프로젝트와 관련이 없는 것에 대해서 생각하고 느낄 수 있도록 하는 것이 이상적입니다. 한편으로, 글쓰기 연습은 혼란스러운 것들을 정화하고 새로운 관점을 주기 때문에 단기간의 명상이나 단기간 휴가와 같은 것입니다.
글쓰기 연습은 이러한 새로운 관념이고 새로운 관조의 방법이며 훌륭한 글쓰기를 위한 관건이 됩니다. 자연적으로 모든 연습이 언제나 마음을 새롭게 하는 것은 아닙니다. 어떤 때는 단지 주어지는 도전에 준비가 되지 않을 수도 있지만 그런 때 일지라도 씨앗은 뿌려진 것입니다. 어떤 때는 글쓰기 연습에 적극적이 아닐 때도 있지만 그래도 괜찮습니다. 다시 말하건대 단순히 연습하는 것만으로도 어떤 생각을 움직이게 하는 것입니다.
글쓰기 연습은 그만한 가치가 있을까요? 물론입니다. 거의 모든 작가들이 그렇게 생각하고 있을 것입니다.
출처: About.com freelance writer’s newsletter, Anne Wayman
내가 쓴 글을 감수하는 방법
자신이 쓴 글에 대한 감수는 필수입니다. 자신이 쓴 글을 감수한다는 것은 대단히 어려운 일이기도 한데 그 이유는 전체 내용을 너무 잘 알고 있고 뒤에 올 것을 모두 알고 있기 때문이기도 합니다. 아래의 방법이 도움을 줄 수 있습니다.
감수 방법:
1) 워드 프로세서에 있는 철자 교정기에 세심한 주의를 기울인다.
글쓰기와 편집에 너무 집중한 나머지 철자 및 맞춤법을 무시하기가 쉽습니다.
2) 원고를 인쇄해서 큰소리로 읽어본다.
느긋하게 해서 오류를 쉽게 발견하게 하고 귀로 들어서 잘못된 것을 지적할 수 있게 합니다.
3) 원고를 최소한 24시간, 가능하다면 며칠 후에 다시 읽는다.
새로운 눈으로 읽을 수 있습니다.
4) 다른 사람에게 부탁한다.
철자 오류나 불분명한 문장만 지적해 주도록 부탁하며 그들의 의견이나 편집을 받아들이지는 않습니다.
5) 원고를 끝에서부터 거꾸로 읽어 본다.
효율성을 고려하여 너무 길 때는 어려운 문장만 거꾸로 읽어 봅니다.
도움말:
1) 감수는 편집이 끝난 후에 한다.
감수는 원고를 납품하기 직전의 작업이므로 편집이 끝난 후에 합니다.
2) 감수자의 선정은 매우 신중하게 한다.
감수만이 그들의 일임을 명심하게 해야 합니다. 호의적인 감수자의 작업이 때로는 더 큰 문제를 일으킬 수가 있습니다.
3) 감수는 필수이다.
선택해서 하는 작업이 아니며 쉬운 것도 아니지만 수락될 수도 있고 잘못하면 거부될 수도 있습니다.
출처: About.com freelance writer’s newsletter, Anne Wayman
테크니컬 라이팅 서적-매뉴얼 쉽게 만들기
지식 근로자의 핵심 역량으로 ‘테크니컬 라이팅’의 중요성이 강조되고 있는 가운데, 특히 기술 연구소의 연구원들에게는 절실한 ‘매뉴얼을 잘 만드는 매뉴얼’이란 주제의 실용서가 국내 최초로 출판되었습니다.
신제품이 개발될 때마다 새로운 매뉴얼은 필요하게 됩니다.
새로운 내용을 짧은 시간에 여러 사람이 함께 제작하려고 하면 다양한 문제가 발생합니다. 더욱이 제조물 책임법(PL)의 발효 이후 제품 사용 설명서의 중요성은 더욱 높아졌습니다. 특히 글쓰기에 익숙하지 않은 이공계 출신의 직장인들에게 매뉴얼 만들기는 부담스러운 업무 중 하나이기도 합니다.
이에 매뉴얼 집필에 어려움을 겪고 있는 기업 및 테크니컬 라이터들을 위해 <매뉴얼 쉽게 만들기>라는 실용서는 간결하면서도 깊이 있는 매뉴얼 작성법을 가르쳐 줍니다.
이 실용서는 매뉴얼 제작 프로세스 6단계, 즉 기획(요구 분석), 설계(목차 구성), 집필(내용 구성), 연출(비주얼화), 검증(제품 실측) 및 제작(인쇄 또는 디지털화)에 대해 실제 사례를 중심으로 알기 쉽게 설명하고 있습니다. 국내 처음으로 출판되는 <매뉴얼 쉽게 만들기>에서 제시한 원리는 개발 계획서, 연구 보고서 등 각종 기술 문서 작성에도 쉽게 응용할 수 있으며, 테크니컬 라이팅의 기본 능력을 키울 수 있는 유용한 실용서라고 할 수 있습니다.
책의 저자인 주식회사 솔트룩스의 김온양 고문은 수 년간 테크니컬 라이팅 컨설턴트로서의 경험과 노하우를 기반으로 책을 집필하였으며, ‘제품 사용 설명서는 사용자 관점에서 제작되어야 함에도 여전히 기술자 관점에서 어렵게 쓰여지고 있는 것이 현실’이라며 조금이나마 도움이 되고자 책을 집필했다고 밝혔습니다.
이번 책의 출간 기념으로 세미나도 기획하고 있는 김온양 고문은 아직은 많지 않은 테크니컬 라이팅 관련 정보를 공유하고자 관련 세미나 개최 및 영문 매뉴얼 제작과 관련한 서적도 발간할 예정이라며 그 포부를 밝히고 있습니다.
저자 소개 – 김온양
1979년 한국 최초로 기술 번역 회사를 창업하여 ‘기술 번역과 테크니컬 라이팅’이란 개념의 업(業)을 국내에 처음 도입하고 확산시킨 개척자.
현재 주식회사 솔트룩스(www.saltlux.com)의 고문이면서 여러 기업체에서 컨설팅과 강의 활동을 하고 있습니다.
무식하게 써라 - 송숙희 칼럼
자고로 말과 글은 쉬워야 한다. 어려울 이유가 없다. 아무리 대단한 전문가가 말을 하거나 글을 쓴다해도 가급적 쉬운 말로 해야 많은 사람이 알아듣는다.
돈이 되는 글쓰기 특강을 듣던 모 기업체 중역 한 분이 질문을 했다. “글을 잘 쓴다함은 어휘가 풍부하다는 얘기일텐데 어휘를 풍부하게 확장시킬 수 있는 방법이 무엇인가”
망설이지 않고 이야기했다. 지금 쓰고 있는 어휘 만으로도 충분하다. 굳이 어려운 어휘들을 익히고 사용할 이유가 있겠는가고. 물론 전문 용어를 말해야 할 때가 없지는 않을 것이다. 그러나 일반적인 글쓰기, 생활글을 쓸 때는 무조건 쉽게 쓰자.
20년 가까이 글을 써온 내가 지금도 수없이 스스로에게 세뇌하는 것이 바로 ‘쉽게 쓰자, 중학교 1학년이라도 이해하기 쉽게 쓰자’는 것이다. 그러다보니 내 글은, 내 책은 소위 전문가들에겐 아이들 만화책처럼 폄하되기도 한다. 그러나 더 많은 사람들, 전문적이진 않지만 생업에서 글쓰기 기술이 꼭 필요한 사람들은 이런 얘기를 왜 이제서야 해주느냐며 꾸짖고 나선다.
쉽게 써라는 명제는 ‘펀(Fun)’과 함께 이즈음의 대중 문화를 관통하는 매우 중요한 이데올로기이다. 블로그나 카페, 댓글 등 보편화된 인터넷 매체에서의 쓰기 또한 쉽게 쓰기가 관건이다.
쉬운 글, 재미있는 글을 쓰는데 뜻밖의 장애물이 있다. 즉, 쉬운 글은 권위가 없다며 구박받기 쉽다. 따라서 쉽게 글을 쓰는데는 용기가 필요하다. 그러기에 마광수 교수 같은 문필가도 쉽게 쓰면 무시당하기 쉽다고 어려움을 토로하기도 했다. 최인호, 헤밍웨이, 박완서 등 내로라하는 작가들의 글도 읽기 시작하면 거침이 없이 쉽다. 무릇, 고수는 어깨에 힘부터 빼는 법. 그러기에 CNN 의 랠리킹은 키스하듯 쓰라고 했다. Keep it simple,stupid - 간단명료하게 그리고 누구라도 이해하기 쉽게.
출처: 코리아인터넷닷컴 칼럼 [송숙희의 돈이 되는 글쓰기]
매뉴얼 라이터의 7가지 태도
테크니컬 라이팅 컨설턴트인 솔트룩스의 김온양 고문은 매뉴얼 라이터의 태도를 아래와 같이 7가지로 정리하고 있습니다. 요즈음 라이팅이 가장 중요한 개인 역량으로 자리매김하고 있는데 테크니컬 라이팅 도서인 "매뉴얼 쉽게 만들기"는 모두들 읽으셨겠죠?
1. 조감범위 -> 나무보다 숲을 보는 안목을 가져라!
2. 패러다임 -> 내 관점보다 상대방 관점에서 생각하라!
3. 기획분석 -> 글 쓰는 요령보다 기획력을 더 키워라!
4. 집필능력 -> 분야별 스타일가이드를 개발하라!
5. 연출효과 -> 읽기 전에 보여지도록 메이크업 하라!
6. 자기계발 -> 3대 영역에서 균형 잡힌 전문성을 확보하라!
7. 반복연습 -> 많이 읽고 다양하게 써 보라!
제품 설명서 제작의 5가지 기준
매뉴얼을 말하기에 앞서 테크니컬 라이팅을 이해해야 알기 쉬운 매뉴얼을 만들 수 있습니다. 기술적인 글쓰기 즉, 테크니컬 라이팅은 기술적인 내용을 독자 대상이나 목적에 따라 알기 쉽고 정확하게 표현하기 위한 문서 작성 수법입니다. 다시 말하면 매뉴얼은 테크니컬 라이팅에 의해 독자의 입장에서 기술 문서 혹은 매뉴얼을 작성하는 것입니다.
* 기획 설계의 중요성: 사용에 필요한 정보가 빠짐없이, 그러나 중복되지 않아야 합니다. 사용자 관점에서 필요한 정보와 개발자 관점에서 필요한 정보는 서로 다릅니다. 또한 개발자와 사용자가 중요하게 생각하는 것도 서로 다르기 때문에 매뉴얼의 기획과 목차 구성은 철저하게 사용자 중심이 되어야 합니다.
* 문장 표현의 간결성: 누구나 쉽게 이해할 수 있고 실질적인 조작이 가능해야 합니다. 동일한 제품일지라도 사용자의 연령 계층과 지적 수준은 매우 다양합니다. 따라서 전문적인 지식이 없어도 읽고 이해할 수 있는 용어와 표현이 필요하며, 절차가 단순하고 명료해야 합니다.
* 문제 해결의 간편성: 사용 중에 문제가 생기면 언제든지 손쉽게 해결할 수 있어야 합니다. 사용자가 사용 방법에 대해 학습을 잘 받으면 무엇보다도 애프터서비스의 필요성이 줄어들고 제품의 수명이 길어집니다. 또한 문제의 원인 제공자가 누구인지 명확해지므로 제품 자체에 대한 중대한 결함이 없는 한 사용자는 자신의 잘못된 사용 방법으로 제품에 문제가 생겼다는 것을 인식하게 됩니다.
* 기능성 중심의 활용: 읽는 매뉴얼이 아니라 보는 매뉴얼이 되어야 합니다. 휴대가 간편해야 하고, 검색성이 높아야 합니다. 특히 공급자 관점에서는 한번 개발한 매뉴얼을 재활용할 수 있어야 합니다. 글로벌 기업들은 대화형 전자 매뉴얼(IETM)을 개발하고 활용하며 그 범위가 넓어지고 있습니다.
* 법률적 요건의 충족: 제조물 책임법에서 요구하는 매뉴얼의 기능이 충족되어야 합니다. 이제는 단순히 제품을 설명하고 사용 방법을 알려주기 위한 용도뿐 아니라 제조물 책임 대책을 위한 제품 안전 관리 체제와 제조물 책임 방어 체제의 일환으로서 경고 대책과 적합한 문서 관리가 필요합니다.
** 저작권은 <매뉴얼 쉽게 만들기>의 저자인 김온양님에게 있습니다.
제품 설명서, 어떻게 만들 것인가?
사용자 지향적 매뉴얼 작성 방법
모든 제품과 서비스의 초점은 고객 만족을 높이는 것입니다. 따라서 제품 설명서를 만드는 일도 마케팅 관점에서 소비자 행동론에 근거하여 개발할 필요가 있습니다.
<제품 설명서 사용자 요구사항>
1. 정확성: 간결하고 논리적인 문장으로 알기 쉽게 작성되었는가?
2. 실용성: 제품 기능과 사용자 중심으로 사용 방법을 설명하고 있는가?
3. 검색성: 알고 싶은 것을 손쉽게 빨리 찾을 수 있도록 구성되었는가?
4. 해결법: 사용 중 문제가 생겼을 경우 사용자의 조치법이 정확한가?
5. 시각화: 설명하고자 하는 개념이 시각적으로 이해하기 쉬운가?
6. 적용성: 사례 중심의 예문을 통해 사용자가 쉽게 응용할 수 있는가?
7. 경제성: 보관, 휴대가 용이하고 사용자의 시간 경제성이 고려되었는가?
글을 쓰는 사람과 읽는 사람 사이에는 근본적인 차이가 있습니다. 더욱이 외국으로 수출되는 제품일 경우에는 언어의 차이는 물론 해당 국민의 정서적 영역까지 고려되어야 합니다. 특히 개발자가 익히 아는 전문 용어들을 사용자가 쉽게 알 수 있는 용어들로 바꿔 주면서 논리적인 순서를 따라 구체적으로 설명해야 합니다.
<개발자(집필자)와 사용자(독자)의 입장 차이>
1. 기능 명세서와 기반 기술 / 제품을 사용하기 위한 정보
2. 기능의 개요와 구성 / 제품 설치, 사용 및 유지보수 방법
3. 각 기능의 해설 / 상황별 기능 조작 순서
4. 설계 시 고려사항 및 취급 주의사항 / 사용 사례(일반, 특수)와 관련사항
5. 전문 용어 사용, 압축과 요약 표현 / 쉬운 용어 사용, 구체적이고 논리적인 설명
그러면 이와 같은 문제를 어떻게 해결할 수 있을까요? 여러 방법들이 있겠지만 우선 사용자 지향적인 매뉴얼의 템플릿을 개발하여 이를 문서화하고 모든 사람들이 공유하는 방법이 있습니다. 문서화는 ‘하고 있는 대로 적는다’는 것이고 표준화란 ‘적혀있는 대로 한다’는 것입니다. 즉 누가 언제 해도 같은 결과가 나올 수 있도록 방법을 표준화해야 합니다. 제품 설명서에 있어서 표준화란 어떤 제품 설명서를 만들 것인가를 결정하는 설계 방법과 제작 방법을 결정하는 것입니다. 이를 위해 매뉴얼 제작 템플릿과 표준 프로세스를 개발하고 스타일가이드와 표준 용어 사전을 구축해 놓으면 유용하게 활용할 수 있습니다.
<제품 설명서에 공통적으로 적용되는 구성요소>
1. 제품 개요: 제품 개요, 특성, 주요 기능, 안전 취급, 포장 풀기 등
2. 설치 점검: 설치 전 점검, 설치 과정(H/W, S/W), 시험 동작 등
3. 운용 조작: 기능별 사용 방법, 각종 지시문, 경고 표시 등
4. 문제 해결: 증상별 메시지, 문제 해결, 자가 진단 방법 등
5. 기타 자료: 색인, 애프터서비스 절차, 보증서, 연락처 등
** 저작권은 <매뉴얼 쉽게 만들기>의 저자인 김온양님에게 있습니다.
글쓰기의 시작 전략과 문장 작성 10계명
문장의 기본은 핵심 문장과 보충 문장으로 구분할 수 있다.
핵심 문장은 주제를 나타내고 문단을 대표하며, 보충 문장은 핵심 문장의 해설 혹은 설명을 도와주는 문장입니다. 기본 핵심 문장은 맨 처음에 서술하는 것이 원칙입니다. 이 핵심 문장에 보충 문장이 논리적으로 연결되어야 합니다.
문장 작성 기준과 문장의 배열
1. 단어는 쉬운 용어를 사용하되 일관성과 통일성을 유지해야 한다. 특히 전문 용어는 용어 해설을 곁들이면 더욱 친절한 제품 설명서가 될 것이다.
2. 약어, 외래어 전문 용어는 표준화된 용어를 사용하고, 필요할 경우 괄호 안에 원문을 표기하는 것이 좋다.
3. 문장은 분명한 동작이나 메시지를 전달해야 한다. 문장을 통해 메시지를 전달할 때는 40자 내외로 간결하면서도 구체적으로 한다.
4. 문단은 기기의 중심 기능이나 동작 또는 주제를 분명히 드러내야 하며, 대개 3~6문장이 적당하고, 문장과 문장 사이에 논리적인 연결이 있어야 한다.
5. 겹문장(복문이나 중문)보다는 홑문장(단문)의 사용을 권한다.
6. 주부(주어부)와 술부(서술부)의 문장 호응 관계가 분명해야 한다.
7. 장문과 단문의 적절한 균형을 이루며, 문장간 접속이 분명해야 한다.
피해야 할 문장 작성 10계명
문장 작성 기준은 글의 성격과 작성자의 견해에 따라 제각기 다를 수 있습니다. 다음의 10계명은 필자가 임의로 구성해 본 것입니다.
1. 대명사 사용 억제: 이것은, 그것은, 그들은, 이들은...
2. 가능한 한 단문 사용: 한 문장은 하나의 주제, 복문과 중문은 가급적 억제
3. 수동식 표현 억제: ~이 주목된다, ~으로 생각된다, ~으로 여겨진다
4. 이중 부정문 남용: ~라고 하지 않을 수 없다, ~이 없는 것은 아니다
5. 추측 표현 자제: ~일 수도 있다. ~이 아닌 듯 하지만
6. 정확한 숫자 표기: 작년 봄에, 매우 드물게, 가끔씩, 많은 적은, 큰, 작은
7. 다의적 용어 사용 금지: 이중적으로 해석될 수 있는 모호한 표현
8. 수식어는 피수식어에 근접: 꾸며주는 말은 꾸밈을 받는 말과 가까이 있어야 함
9. 주부와 술부의 관계 호응: 주어(주격)와 서술어(서술격)의 수식 관계가 맞아야 함
10. 핵심 주제를 첫머리에: 가장 중요한 메시지를 가장 앞에 위치시킨다.
** 저작권은 <매뉴얼 쉽게 만들기>의 저자인 김온양님에게 있습니다.
훌륭한 테크니컬 라이터는 글로벌리제이션 도우미
소비재 제품 생산업자는 경쟁사보다 먼저 시장에 제품을 출시하기 위하여 휴대전화, 카메라 및 고급 전자 제품을 배우려고 상당한 압력을 받습니다. 이 물건들의 시장은 이제 세계이기 때문에 경쟁사보다 먼저 시장에 출시하는 것은 사용자 지침이 여러 나라 말로 준비가 되어야 하기 때문에 매우 복잡한 과정입니다.
회사는 자사의 제품을 사용자들이 쉽게 알 수 있도록 하고 전반적인 문서 제작 비용을 최소화하기 위하여 훌륭한 테크니컬 라이터를 찾게 됩니다.
이들 테크니컬 라이터들은 다음과 같은 문제들에 직면하게 되고 해결책 마련을 위해 고심하게 됩니다.
- 통상적으로 테크니컬 라이팅과 글로벌리제이션은 제품 생산이 종료되기 전에 시작된다. 이 압축된 일정은 경쟁사에 앞서기 위해서 필수이다. 그런데 회사는 제품을 중도에 변경 시킬 수도 있으며 이럴 때에는 제품의 기계적인 기반 시설과 소프트웨어의 변경으로 이어질 수도 있으며 사용자 지침서도 이 변경을 모든 언어로 정확하게 반영해야 하는 일이 일어나게 된다. 완성된 텍스트를 준비되는 대로 보내게 함으로써 로컬리제이션과 저작 과정을 일치시키게 하려면 모듈 솔루션을 사용할 수도 있다.
- 테크니컬 라이터는 불필요한 정보를 뽑아내야 한다. 테크니컬 라이터가 제품 정보를 얻기 위해서 인터뷰를 할 때에 엔지니어들은 대개 사용자가 알아야 하는 것 보다 더 많은 정보를 주게 마련이다. 엔지니어가 말하는 것을 모두 사용자에게 설명할 필요는 없다. 물건이 어떻게 작동하느냐를 알고 싶어하지 왜 작동하느냐를 알고 싶어하지는 않는다.
- 테크니컬 라이터는 로컬리제이션 감각을 갖고 글을 써야 한다. 로컬리제이션 절차를 충분히 이해하지 못한 채 문서 작성을 하는 라이터가 꽤 많다. 오늘날에 있어서 효과적인 문서를 작성하려면, 테크니컬 라이터는 자신들의 행동이 사용자 지침서 개발 절차의 다음 단계에서 언어 학자들에게 일으킬 수 있는 문제점들을 잘 알아야 한다. 어떤 고객 중에 30개 국에서 30개 언어로 휴대전화를 판매하는 회사가 있다. 이 경우 저작 단계에서 소개된 각각의 문제점들은 나중에 각기 다른 30개의 문제점을 번역가들에게 줄 수 있다.
출처: 바운글로벌 뉴스레터 <Global Solutions at Work> 2005년 2월호
PR