본문 바로가기
728x90

테크니컬 라이팅

 (310)
WTD 포틀랜드 2021 요약 - 개발자를 위한 튜토리얼 잘 쓰기 발표자는 Jessica Garson. 트위터 개발자 애드보케이트입니다. 예전에는 기술 에반젤리스트 뭐 이런 표현을 많이 쓰는데 요즘에는 애드보케이트를 더 많이 쓰는 것 같습니다. 트위터도 그렇고 AWS도 그렇고~ 에반젤리스트는 기술에 집중한다면 애드보케이트는 좀 더 사용자에 집중하는 느낌입니다. 튜토리얼을 공식적으로 테크니컬 라이터가 작성하기도 하지만, 발표자의 주요 업무(?) 중 하나가 개발자의 문제 해결을 위한 튜토리얼 작성이라고 합니다. 레퍼런스 가이드는 각각의 기능을 설명하지만, 특정 문제에 대한 해결책을 안내하지는 않습니다. 문제 해결을 위해서는 다양한 기능 요소들을 적절하게 조합하고 풀어내는 것이 필요한데 그런 일은 주로 커뮤니티에서 콘텐츠를 많이 만들어내고 있죠. 하지만 개발자 애드보케이트가..
공문서 쉽고 바르게 쓰기 일반적인 글쓰기 매뉴얼은 아닙니다. 전북교육청에서 공문서 작성 시 참조할 수 있도록 매뉴얼 형태로 작성한 자료입니다. 하지만 내용 중 "문서 작성의 원칙"이나 "문서의 작성" 내용은 다른 글쓰기에서도 참조할만한 내용이라 소개해봅니다. 자료는 아래 링크에서 내려받을 수 있습니다. www.jbe.go.kr/board/view.jbe?menuCd=DOM_000000105002003000&boardId=BBS_0000209&dataSid=567713 페이지로 15페이지 정도의 짧은 내용이니 한번 쓰윽 보고 넘어가도 좋습니다. 문서 작성의 원칙 뭔가 7가지 글쓰기 원칙 그런 거 나올 것 같지만 그냥 달랑 4줄만 나와있습니다. 첫 번째는 뭐 신경쓸거 없고요. 두 번째 항목을 따라가보면 아래와 같은 내용입니다. “어..
탐색 모음 "navbar"라는 용어가 있습니다. MS 언어 포털에서 찾아보면 "탐색 모음"으로 번역해줍니다. 메뉴바라고 번역하지 않는 이유는 Visual Studio 같은 도구에서 정말 순수하게 어떤 정보를 탐색하기 위한 도구의 모음이기 때문입니다. 이런 형식이죠. 정확한 표현은 navigation bar인데 줄여서 navbar라고 표현하기도 합니다. 메뉴 영역은 별도로 있고 저 부분은 탐색을 위한 도구이기 때문에 "탐색 모음"이 적절한 번역입니다. 하지만 도큐사우루스 같은 경우 메뉴 영역과 탐색 모음 영역이 navbar 영역으로 취급됩니다. 때문에 이걸 "탐색 모음"이라고 번역하면 좀 어색한 표현이 되어버립니다. MS에서 이야기하는 navbar와 도큐사우루스에서 이야기하는 것이 살짝 다른 지점을 가리키고 있어서~..
클라우드랑 사무실 어딘가 처박혀 있는 서버와 무슨 차이가 있나요? "클라우드 에반젤리스트가 들려주는 클라우드 이것만 기억하자!"는 제목의 영상 리뷰입니다. 개요 수준의 영상이라 생각했지만, 영상의 명확한 시청자(?) 층을 어느 정도 수준으로 생각했는지 모호한 내용입니다. 이미 클라우드를 사용해보았다면 다 아는 내용일 것이고, 클라우드를 전혀 접해보지 못한 사용자에게는 클라우드의 장점을 또렷하게 드러내지 못한 설명이 아니었나 싶네요. 혹시 사무실 어딘가 처박혀 있는 서버랑 클라우드가 무슨 차이가 있는지 궁금하시다면 한 번 정도 보는 것도 나쁘지 않습니다. 영상은 아래 링크에서 보실 수 있습니다. https://tv.naver.com/v/16971190 클라우드 에반젤리스트가 들려주는 클라우드 이것만 기억하자! NAVER Engineering | 정낙수 - 클라우드 에반젤..
라인에서 테크니컬 라이터는 어떻게 일할까? 지난 3월 일본 라인에서 테크니컬 라이팅 밋업이라는 영상을 공개했습니다. 라이브로 진행된 밋업을 정리해서 유튜브에 공개했더군요. 매달 1회 정도 진행할 예정이라고 합니다. 3월에 공개한 영상은 2개의 세션으로 진행됐는데 첫 번째 세션은 개발자를 위한 글쓰기 팁이고 두 번째 세션은 테크니컬 라이터가 하는 일에 대한 소개입니다. 두 번째 세션에 일본 라인에서 어떤 식으로 일을 하는지 간단하게 소개하고 있어 그 내용을 간략하게 소개합니다. 1. 테크니컬 라이터는 무슨 일을 하나요? 어떤 글을 쓰나요? 주로 하는 일은 외부에 공개되는 개발자 문서를 작성합니다. 예를 들어 라인 로그인 기능을 내 사이트에서 어떻게 구현해야 하는지 알고 싶다면 라인 개발자 사이트에서 관련 가이드와 API 문서를 찾을 수 있습니다. ..
예제와 예시 문서 내에서 예를 들어 설명하는 코드나 이미지를 "예제"라고 써놓았더군요. 예전부터 그렇게 쓰고 있었고 읽었을 때 뭔가 이상한 느낌이 없어서 계속 쓰고 있었는데, 생각해보니 "예제(例題)"는 한자에서 보듯 "보기로 들어주는 연습 문제"라는 의미입니다. 보여지는 코드가 문제 유형이라면 괜찮겠지만 보통은 예시로서 보여주는 것이기 때문에 "예제"는 적합한 표현이 아닌 것 같습니다. "예시(例示)"가 좀 더 적절한 표현이겠네요. 영어 사전만 봐도 "예제"는 "exercise, practice problem"이고 "예시"는 "example, illustration"입니다. 보통 문서 내에서는 "Example"의 의미로 사용하기 때문에 "예시"가 맞겠죠. 그냥 "예"라고 표현해도 되고요.
NHN 테크니컬 라이터가 추천하는 테크니컬 라이터를 위한 참고 도서 (1) '개발자를 위한 글쓰기 가이드 / 유영경 / 로드북'에서 참고자료(도서) 목록을 정리했습니다. 이번 글에서는 번역서 또는 국내서를 먼저 소개합니다. 1. 바바라 민토, 논리의 기술 국내에서는 2005년, 2019년 두 차례 출판됐습니다. 국내에 나온 책은 1996년판을 바탕으로 번역했다고 하는데 원서 최신판은 2010년판입니다. www.barbaraminto.com/textbook.html 사이트를 보면 기존 책(The Pyramid Principle: Logic in Writing and Thinking)을 새로운 책(The Minto Pyramid Principle: Logic in Writing, Thinking and Problem Solving)이 대체한다고 명시되어 있는데 뭔가 저작권 관련 분..
차출과 착출 한 줄 요약 "차출"과 "착출"은 같은 의미는 아닙니다. 하지만 "착출"이 없는 단어도 아닙니다. 메신저로 대화를 하다가 "착출 되었답니다"라는 표현을 쓰고 나서 뭔가 느낌이 이상해서 사전을 찾아보니 "착출"이라는 단어는 없고 "차출"이 맞는 표현이라고 합니다. 다행스럽게도 신문기사에서도 "착출"이라는 표현을 간혹 쓰는 걸 보면 많이 틀리는 표현인가 봅니다. 그런데 국립국어원 답변이 좀 애매합니다. 착출이 맞는지 물어보는 질문에 한자 표현일 수도 있다는 답변을 남기더군요. 보통 오타라고 판단되면 "차출의 오타입니다"라는 식으로 답변을 달아주는데 말이죠. 그래서 찾아보았습니다. 국어사전뿐 아니라 한자사전에서도 "착출"은 보이지 않습니다. 일본어 사전에는 표현이 있긴 한데, 좀 다른 의미인 듯하네요. 하지만..
반응형

티스토리툴바