본문 바로가기

728x90

테크니컬 라이팅

(353)
언어에 따라 달라지는 릴리스 노트의 느낌 우연히 카카오톡 PC 버전 릴리스 노트(공지사항)를 봤습니다. 릴리스 노트는 "Update History"라는 항목으로 제품 안에서 제공되고 있고 웹사이트에서는 간단한 공지 형식으로 정보를 제공합니다. PC 환경이 영어로 되어 있어서, 영어 공지를 먼저 봤는데, 뭔가 너무 간단하다는 느낌이 있어서, 다른 언어(한국어, 일본어)를 비교해봤습니다. 한국어 한국어는 변경된 기능에 대한 이미지 설명을 포함합니다. 딱딱한 공지 문구보다는 뭔가 아는 친구에게 이야기하는 느낌입니다. ~시죠. ~어요. 와 같은 표현들이 그렇죠. https://events.kakao.com/talk/notices/ko/2313 영어 영어는 일단 간단합니다. 그냥 전달할 내용만 딱 써놓았습니다. https://pc.kakao.com/ta..
2017 TC 컨퍼런스 벌써 6번째 참석입니다. 최근에는 딱히 흥미로운 이슈가 없긴 한데, 그럼에도 관련 동향을 얻을 수 있는 몇 안되는 창구라서, 참석했습니다. 작년과 다른 것은 알파고의 영향이 이제 현실이 되고 있습니다. 작년까지만 해도 자동번역을 비즈니스로 활용하는 곳은 많지 않았는데 이제는 아예 견적에서 자동번역을 따로 처리하고 있습니다. 번역 메모리와는 좀 다르게 아예 사람의 손을 거치지 않고 자동번역만 처리하고 비용을 청구하는 경우도 생기고 있다는 것이지요. 디바이스가 스마트해지면서 매뉴얼이 대처할 수 없는 영역으로 들어서고 있습니다. 사진에 보여지는 제품은 2만5천개 정도지만 "Harmony Elite"라는 리모콘은 약 27만개의 제품을 대응한다고 합니다. 로지텍 제품인데 가격이 20만원대라 굳이 이런 제품이 필요..
2016 TC 컨퍼런스 올해도 참석했습니다. 원래 계획대로라면 올해부터는 더 이상 참석하지 않아야 하는데 어쩌다 보니 올해도... 내부 사정으로 준비가 늦어졌다고 하는데 생각보다 강사진은 흥미롭게 구성됐습니다. 다만 전시부스는 예전같지는 않네요. 딱히 새로운 솔루션도 없고 기업 내 사정 때문에 신규 프로젝트도 줄어든 듯 합니다. 이제는 커뮤니케이션이라는 용도도 바꾸어야 하지 않을까 하는 의견도 등장했습니다. 커뮤니케이션 이상의 뭔가가 필요하다는 이야기죠. 사람과 사람을 연결하는 것이 단지 커뮤니케이션으로 제약하기에는 한계가 있다는... 전체적인 프로그램은 아래와 같습니다. 지능정보 시대의 TC왜 지능형 콘텐트인가?제품의 안전 정보, 안전한가?매뉴얼 개발을 위한 CMS 도입 사례와 적용 방안문장 편집, 교정 기호의 표준화 동향I..
2015 TC 컨퍼런스 네 번째 참석입니다. 매년 글을 남기고 있지만 여전히 글을 쓰는 능력은 제자리인듯 합니다. 관련 업계는 여러 가지로 위기인듯 합니다. 문서 형태의 매뉴얼이 사라지고 있고 전자 매뉴얼 보급으로 인쇄 등에서 떨어지는 전체적인 수익도 열악해지고 토탈 솔루션을 제공하는 해외 벤더 덕분에 솔루션 비용을 제하면 남는 것은 많이 줄어들지 않았을까 싶습니다. 그럼에도 새로운 제작 방식(모듈화라든지)가 안정적으로 자리잡고 있고 점점 세분화되는 영역 속에서 준비를 한 기업들은 나름 선방하고 있지 않은가 싶네요. 올해 발표 주제는 아래와 같습니다.'변화하는 세계, 변화하는 TC 시장' 신기술이 가져온 산업과 생활의 변화 신기술이 TC에 미치는 영향 '직관적 자유' 소비자는 이런 가전 매뉴얼을 원한다 ICT 산업계에서의 한국..
초보 API 문서 작성자에게 필요한 것 이번 글은 Lessons Learned as a Novice API Writer 라는 글인데 처음 API 분야에 뛰어드는 분들에게 조언이 되는 좋은 글이 많이 남겨져 있네요. 물론 API가 아니더라도 테크니컬 라이팅 분야에 종사하는 분들이라면 모두에게 해당하는 내용입니다. 특히 인상적인 내용은 아래 문구였습니다....I reviewed specifications and researched technologies used by the team so that I could ask better questions and save the team time by focusing on their current development efforts... 기술 분야에서 연구 인력 또는 개발자가 가이드를 작성하는데 있어서 ..
쓸만한 샘플 코드는 어떻게 만드나요 How to Write Helpful Code Samples 라는 글입니다. Sarah Maddox는 구글에서 테크니컬 라이터로 일하고 있으며 그 전에는 아틀라시안, HP 등에서 일했다고 합니다. 9년 동안은 엔지니어로 그 후로는 테크니컬 라이터로 일하고 있네요. 현재 하고 있는 일이 주로 구글맵 관련된 일이라서 그런지 주로 구글맵 사례로 설명을 해주고 있습니다. 블로그에 올린 글 중에 How to write sample code 라는 글이 있는데 내용은 비슷한 것 같네요.http://ffeathers.wordpress.com/2013/12/21/how-to-write-sample-code/ 이전 글에서 다룬 것처럼 API 문서에 들어가는 텍스트 영역은 사용자가 직접 접하는 부분이고 누구나 쉽게 사용할 ..
좋은 API 문서는 어떻게 만들지? 이번에는 What Factors Contribute to Good API Documentation? 이라는 글입니다.테크니컬 라이터가 활동할 수 있는 시장은 점점 작아지고 그 틈새 시장으로 API 라는 것이 떠오르고 있다는 것을 알았다면. 이제는 좋은 API 문서가 어떤 것인지 알고 자신의 경쟁력을 높이라는 의미겠죠. 단순히 문서 교정자로서 참여하는 것이 아니라 API 기획 단계에서 참여하는 것을 전제로 합니다. API Design 이라는 표현을 사용하고 있네요. 예를 들어 설명하는 내용은 아래와 같습니다....Similarly, using a delete method for all three object types is consistent, but if you instead used “remove” f..
API 문서화 작업은 어떻게 참여할 수 있나요? Scot marvin이 쓴 글을 읽을 때는 몰랐는데 북미 쪽에서 테크니컬 라이터의 지위 또는 일자리가 넉넉치 않나 봅니다. 전통적인 매뉴얼 시장이 아무래도 축소되고 있어서 새로운 시장을 찾아야 하는 위기가 다가오고 있어서 아마도 이번 특집이 마련된 것이 아닌가 싶습니다.2014/10/30 - [인사이드TW] - API 문서화는 누가 하나요? Mary Conner의 글은 이런 점을 솔직하게 드러내고 있습니다. 제목부터가 'How Do You Break into API Documentation?'으로 테크니컬 라이터가 API 문서화라는 새로운 시장에 어떻게 진입할 수 있는지에 대한 가이드입니다. 아직은 시장이 블루오션이라 기존 매뉴얼 작업 대비 1.5~2배 정도 시간 당 수익을 낼 수 있다고 하네요. 원격에..

반응형