테크니컬 라이팅
-
매뉴얼 구조화테크니컬 라이팅 2016. 3. 3. 08:50
많은 글쓰기 지침들이 차례의 중요성을 강조한다. 차례 짜기가 문서 기획에서 상당 부분을 차지해야 한다고 말한다. 많은 사람들이 아래와 같이 여러 수준을 사용하여 문서를 구조화한다.장 (Chapter) 1 절 (Section) 1.1 절 (Section) 1.1.1 절 (Section) 1.1.1.1하나의 문서는 여러 주제들로 이루어진다. 어떤 주제에서 그 내용이, 그 내용의 길이와 관계 없이, 주제를 완결적으로 다루었을 때 그 주제가 독립적인 것으로 간주된다. 현미로 맛있는 밥을 짓는 방법으로 이야기가 시작해서 현미가 백미보다 건강에 좋은 이유로 이야기가 끝난다면 그것은 아직 사람들에게 보여줄 수 있는 글이 아니다. 다층 구조로 이루어진 글에서 우리는 몇 가지 의문을 갖게 된다. 위의 예를 사용하자면, ..
-
문서 개발 프로세스테크니컬 라이팅 2016. 3. 3. 08:42
조앤 해코스(JoAnn Hackos)는 “문서화 프로젝트 관리 (Managing Your Documentation Projects)”에서 문서 개발 프로세스를 다섯 단계로 나눈다.정보 계획 (information planning): 문서 기획에 필요한 정보를 수집하고, 문서 얼개를 대략적으로 계획한다. (10%)내용 상세화 (content specification): 보다 상세한 정보를 수집하고, 세부 단위까지 문서 구성과 내용을 계획한다. (20%)실행 (implementation): 짜여진 계획에 따라 내용을 작성하고, 삽화를 그리고, 문서를 조판한다. (50%)발행 (production): 필요하다면 번역하고, 인쇄나 배포가 가능한 형태로 문서를 마무리한다. (19%)평가 (evaluation): ..
-
둘 이상의 언어로 만들어야 한다면 원문을 영어로테크니컬 라이팅 2016. 3. 3. 08:37
기술 문서의 번역에서 대부분의 사람들이 세 가지 언어만이 한국어에서 직접 번역하는 것이 가능하다고 여기고 있다. 영어, 일본어, 그리고 중국어가 이에 해당된다. 엄밀히 말하자면 한국 안에서 어렵지 않게 구할 수 있는 번역사들이 사용하는 언어가 이 세 가지에 국한되어 있다. 한국어에서 러시아어로 번역할 수 있는 사람을 찾는 것이 불가능하다고 말할 수 없겠으나 그것은 여전히 요행을 바라는 것에 지나지 않는다. 번역 회사들은 사업을 요행에 맡기지 않는다. 그들은 제휴할 수 있는 번역 회사나 번역사들을 러시아에서 찾는다. 물론 한국어에서 바로 러시아어로 번역할 수 있는 사람은 러시아에도 없다고 봐야 한다. 영어는 실제 만국 공통어이고, 번역 업계에서 대부분 영어가 원문의 언어라고 간주한다.번역비는 번역사가 속한..
-
테크니컬 라이터의 고유 능력테크니컬 라이팅 2016. 3. 3. 08:35
테크니컬 라이터(technical writer)는 기술적인 정보를 전달하는 문서를 작성한다. 말 그대로 技術 作家이다. 이들이 다른 저술가들과 어떤 점에서 다른지 살펴 보겠다.저술과 관련된 일을 하는 사람들이 많다. 조선학 교수는 석유 시추선에 대해, 의학 전문 기자는 메르스에 대해, 서울시의 홍보 담당자는 서울역 고가도로의 공원화에 대해 글을 쓴다. 이런 사람들에 비해 테크니컬 라이터만이 갖고 있는 고유한 능력이 있을까?글쓰는 사람들은 모름지기, 교열가의 도움을 받는다 해도, 문법과 어법에 대해 상당한 지식을 갖추어야 한다. 그러니 테크니컬 라이터도 당연히 자기가 사용하는 언어를 공부해야 한다. 그러나 다른 이들에 비해 테크니컬 라이터에게 더 높은 수준의 어학 지식이 요구되는 것은 아니다. 그러므로 이..
-
WYSIWYG과 WYSIWYM테크니컬 라이팅 2016. 3. 3. 08:33
WYSIWYG (What You See Is What You Get) 인터페이스를 사용하지 않는 소프트웨어를 찾기 어려울 만큼 이제 위지익은 아주 당연한 것으로 간주된다. 마이크로소프트 워드를 비롯한 인쇄 기능을 제공하는 모든 소프트웨어가 그야말로 화면에서 보이는 대로 내용을 인쇄한다.위지윅은 편리의 상징이고, 인터페이스가 편리할수록 효율성이 높아진다. 그러니 위지윅이 좋아질수록 효율성이 높아진다고 기대할 수 있겠다. 그런데 위지윅 인터페이스가 한계 없이 향상될 수 있을까? 인디자인은 메뉴바와 툴바에 다 담을 수 없을 만큼 많은 기능들을 제공한다. 이 문제에 대한 해법으로서 인디자인은 패널들을 사용한다. 사용자들은 필요한 패널들만 화면에 표시되게 할 수 있다. 기능이 늘어날수록 사용성의 복잡도가 증가한다..
-
출판 소프트웨어를 선택할 때 고려해야 할 것들테크니컬 라이팅 2016. 3. 3. 08:28
매뉴얼 개발에서 가장 먼저 맞닥뜨리는 문제가 출판 도구의 선택이다. 다음 세 가지 파일 형식이 매뉴얼 매체로서 사용된다.PDFHTML동영상매뉴얼 매체로서 HTML과 동영상이 점점 더 많이 주목받고 있으나, 아직은 소프트웨어 산업에 국한되어 있다. 이 글에서는 PDF 제작의 관점에서만 출판 도구들을 다루겠다. 출판 도구를 선택할 때 다음과 같은 점들이 고려된다.타이포그래피효율성비용위의 기준들을 갖고 마이크로소프트 워드를 비롯한 여러 출판 소프트웨어를 비교해 보겠다.타이포그래피행 정돈출판 소프트웨어의 타이포그래피 기능들 가운데 가장 중요한 것이 행 정돈(justification)이다. 흔히 생각하는 것과 달리 출판 도구들은 행 정돈에서 차이를 보여준다. 좋은 소프트웨어는 다음과 같은 결과를 만들어낸다.양끝 ..
-
매뉴얼의 가치에 대하여테크니컬 라이팅 2016. 3. 3. 08:23
매뉴얼을 읽는 사람이 별로 없다는 믿음이 널리 퍼져 있다. 우리 사회에서는 이것이 사실에 가깝다. 매뉴얼이 우리 사회에서 중시되지 않는 데에는 여러 요인이 있다. 무엇보다도 서비스 비용이 상대적으로 적게 든다. 밥솥이 제대로 작동하지 않을 때, 주부들은 다음의 방법들을 차례로 시도한다.남편에게 고쳐달라고 한다.콜 센터에 전화하여 증상을 설명한다. 운이 좋다면 문제가 해결된다. 그렇지 않다면 하루나 이틀 뒤에 수리 기사가 방문할 것이라는 답변을 듣는다.서비스 센터가 근처에 있다면 문제의 제품을 갖고 찾아간다.제조사에 문제의 제품을 보낸다. 일 주일 뒤에 수리된 제품을 돌려받는다.이 과정에서 소비자가 부담해야 하는 비용은 그다지 많지 않다. 서구에서 수리 기사를 부르는 것은 신중을 요하는 일이다. 결함이 없..