본문 바로가기

728x90

테크니컬 라이팅

(353)
당신만 아는 '당신'의 의미 어제 페이스북에 '당신' 뭐 그런 이야기가 나오길래 뭔지 궁금했지만 찾아보지 않았는데 오늘 아침 뉴스를 보니깐 이런 사건이 있었군요. 기사에도 나오지만 일단 당사자가 해명한 글부터 살펴보죠. 문정복 의원 페이스북입니다. 다음은 류호정 의원 페이스북입니다. 국어사전을 찾아보면 '당신(當身)'이라는 대명사를 찾을 수 있습니다. 류호정 의원은 4번 의미로 해석을 했을 것이고, 문정복 의원은 5번 의미로 발언을 했을 겁니다. 국어사전에는 5번에 대한 설명이 좀 부족한데 '자기(自己)'를 찾아보면 좀 더 자세한 설명이 나와있습니다. 그냥 바로 사용하는 것이 아니라 앞에 이미 나온 사람을 다시 가리키는 삼인칭 대명사(재귀 대명사)입니다. 아래와 같이 앞에 이미 나온 사람(빨간색)을 다시 가리키는(하늘색) 형태입니다..
WTD 포틀랜드 2021 요약 - 오픈 소스 프로젝트 문서화에 참여해보세요. Abigail McCarthy는 VMware 오픈 소스 기술 커뮤니케이션 매니저입니다. 여러 가지 일을 하겠지만 주로 오픈 소스 프로젝트 문서화에 참여하고 커뮤니티를 지원하는 역할을 합니다. 기존에는 제품 매뉴얼을 전담했던 테크니컬 라이터였습니다. 많은 기술 기업이 그렇듯이 VMware도 오픈 소스에 많은 투자를 하고 있습니다. https://www.vmware.com/opensource.html 에서 참여하고 있는 오픈 소스 프로젝트 목록을 확인해볼 수 있습니다. Guide to getting started in open source https://youtu.be/3prrgLv4qt4 오픈 소스 프로젝트는 문서화를 위한 도움이 항상 필요합니다. 발표자처럼 풀타임으로 문서화 작업을 지원하는 팀이 있다면 ..
WTD 포틀랜드 2021 요약 - 완벽함이란 없다 Daniele Procida는 DIVIO라는 앱 플랫폼 회사의 CCO(Chief collaboration officer)입니다. CCO는 우리말로는 협업 관리자인데, 이게 무슨 협회도 있고 꽤 뭔가 움직임이 많네요. 주로 "조직의 협업 업무를 기획하고 촉진하고 평가하고 확산시켜 조직성과를 높이는 사람"의 역할을 한다고 합니다. 하여간 이 분은 사내 문서화뿐 아니라 오픈소스 진영의 문서화 작업에도 많이 참여하면서 경험한 이야기를 공유합니다. Always complete, never finished youtu.be/Wc7n7uIg4AM 세션 제목은 조부모님이 물려주신 가구에 붙어있는 로고 문구라고 합니다. 구글에서 검색해보면 책장 쪽에서는 좀 유명한 브랜드인가 봅니다. 강연 내용은 뭔가 말은 많은데 요약해보..
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 문서를 찾을 수 있습니다. ..

반응형