테크니컬 라이팅 (310) 썸네일형 리스트형 개발자의 글쓰기, 개발자를 위한 글쓰기 가이드 '개발자의 글쓰기'는 2019년 10월 초판이 나왔습니다. 이공계를 위한 글쓰기 책은 꽤 많이 나와있고 대학에서도 기본 교양 과목으로 가르치고 있습니다. 하지만 개발자만을 위한 글쓰기 가이드는 없었습니다. 책 표지부터 변수 네이밍, 릴리스 노트, 장애 보고서 같은 실무적인 영역을 건드리고 있습니다. 그리고 저자인 김철수 님이 다양한 주제의 기업 강의를 진행하고 있는데 거기에 '개발자의 글쓰기'라는 강의 콘텐츠가 추가되는 형태라 단체로 책을 주문하고 강의를 진행하는 건도 꽤 있는 듯합니다. '개발자를 위한 글쓰기 가이드'는 테크니컬 라이터가 쓴 글쓰기 가이드입니다. 2003년 'HTML HELP FILE 제작과 실무' 이후 18년 만에 나온 책입니다(중간에 '서비스 글쓰기의 모든 것'이 있지만 이건 공저자.. API The Docs 2020 - API 제품 수명 주기 자동화 제목에서 알 수 있듯이 문서가 아닌 전반적인 API 제품 라이프사이클에 대한 이야기입니다. 발표자인 Jeremy Glassenberg는 테크니컬 라이터가 아닌 PM 경력을 가진 분이며 주로 컨설팅을 하다가 최근에 DocuSign이라는 회사에 합류했습니다. https://youtu.be/VwSwg72HQNE 2008년 XML 기반의 API부터 시작해서 가볍게 API의 역사를 살펴보고 API 제품 수명 주기에 대해서도 살펴봅니다. 그리고 "API를 개선하기 위해 다음 단계"라는 주제로 자동화에 대해 살짝 살펴보고 넘어갑니다. 30분이라는 시간의 제약이 있겠지만, 세션 제목인 자동화에 대한 비중이 부족한 것은 아쉽긴 합니다. 뭐 그래서 결론은 이 두 장의 슬라이드인데~ 자세한 내용은 직접 살펴보라는 ~ 역시 .. web.dev 번역은 언제? 구글에서 제공하는 동영상 목록을 살펴보다가 "web.dev의 세계화 (폴란드어 진행, 영어 자막 제공)"라는 제목의 영상을 보았습니다. "국제 모국어의 날" 기념으로 영어가 아닌 폴란드어로 진행한 영상이었습니다. 제목에 영어 자막 제공이라고 해서 당연히 영어 자막만 있는 줄 알았는데 한국어 자막도 제공합니다 ㅠㅠ https://youtu.be/ds2yMKnIjGI https://developers.google.com/web 에 있던 콘텐츠가 web.dev로 옮겨지면서 기존 번역 문서들이 같이 옮겨지지 않아 그 작업을 한 것인가 싶었는데 아직 그 수준은 아닌가 봅니다. 그냥 다국어 지원은 왜 필요하며 구글에서 어떤 식으로 다국어 지원을 하고 있는지에 대한 설명 정도입니다. 사이트 접속 통계를 보면 한국어 .. 베링랩 CAT 도구 사용 후기 베링랩은 AI 기술을 기반으로 번역 서비스를 제공합니다. 현재는 법률 서비스에 특화되어 있고 기술, 특허, 금융 쪽으로 확대할 계획인 듯합니다. 서울대, 네이버 등의 투자를 받았다고 합니다. 베링랩 서비스는 유료인데 CAT 도구인 intellicat은 무료로 공개 서비스를 제공하고 있습니다. 언제까지 무료인지는 모르겠으나 일단 사용해보았습니다. 간단한 제품 소개는 https://www.beringlab.com/intellicat?lang=ko 에서 확인할 수 있습니다. 사용을 위해서는 회원 가입이 필요합니다. https://translate.beringlab.com/ https://translate.beringlab.com/ translate.beringlab.com 프로젝트 생성 프로젝트명을 설정하고 .. API The Docs 2020 - Spec-First API 만들기 Ivana Isadora Devcic는 이 발표를 할 즈음에 Redocly로 이직을 했습니다. 그 전에는 ReversingLabs에서 테크니컬 라이터로 일했다고 합니다. 아마 이 발표에는 ReversingLabs에서의 경험이 담겨 있는 것이 아닌가 싶네요. https://youtu.be/KnO7q1LsCwQ Spec-First API의 장점을 설명하고 이를 구현하려 할 때 장애가 될 수 있는 문제가 어떠한 것인지 설명합니다. 그리고 변화를 이끌어내기 위해 필요한 아이템을 게임을 빗대어 설명하고 있습니다. 개인적으로는 게임에 별로 익숙하지 않아서인지 딱히 와닿지는 않았습니다. https://pronovix.com/event/api-docs-virtual-2020/ivana-isadora-devcic Iva.. 목적과 목표 갑자기 objective와 goal의 차이가 궁금해서 자료를 찾아보다가 흥미로운 글을 찾았습니다. 먼데이닷컴이라는 협업 솔루션 블로그인데요. 보통 글로벌 업체는 본사 블로그를 그대로 해석하거나 자체 콘텐츠를 만드는데 여기는 본사 블로그 콘텐츠를 한국 사정에 맞게 수정해서 콘텐츠를 만들고 있더군요. 일단 원문은 "Goal vs. objective: what’s the difference?"라는 글입니다. https://monday.com/blog/project-management/goal-vs-objective/ Goal vs. objective — are they the same? | monday.com Blog Learn the difference between a goal vs. an objectiv.. API The Docs 2020 - 개발자 포털 사이트 개발 시 페르소나 활용하기 Louis Debatte-Monroy는 TOMTOM 개발자 제품 마케팅 책임자입니다. TOMTOM은 지도 관련 솔루션을 개발하는 기업입니다. 2004년 1세대 내비게이션 장치를 만들었다고 하네요. 지금도 꽤 많은 사용자를 보유하고 있는 듯합니다. 지도, 길안내 관련 SDK, API를 제공하고 있고 개발자 포털 사이트를 운영하고 있습니다. 이번 발표는 개발자 포털 사이트(https://developer.tomtom.com/)를 개발하면서 페르소나를 활용한 사례를 발표하고 있습니다. https://youtu.be/BJSa5UyZB9k 디테일하게 개발자 포털 내에서 API 문서를 페르소나 또는 독자에 대한 정의를 통해 세분화해서 만든 그런 이야기는 아니고 해커, 엔지니어, 스타트업 CEO, PM 4가지 유형에.. API The Docs 2020 - API 코드를 테스트하기 Milecia McGregor는 conducto의 개발자 애드보케이트입니다. conducto는 데이터 과학 파이프라인을 만들기 위한 플랫폼 기업입니다(정확히 뭘 하는 회사인지는 잘 모르겠습니다 ㅠㅠ https://www.conducto.com/ 를 참고하세요). API 문서를 제공하는 경우 실제 동작하는 코드를 문서 내에 삽입하게 되고 개발자는 그 코드를 가져다가 확인하고 사용합니다. 하지만 코드가 동작하지 않는다면 전체 문서와 제품에 대한 신뢰를 잃어버릴 수 있죠. 그래서 코드를 테스트하는 것이 중요하다고 합니다. https://youtu.be/E9zod8-I-fs 문서 작성 시 개츠비를 사용하는데 개츠비 플러그인 중에서 별도 코드 파일을 마크다운 문서에서 가져와서 사용할 수 있는 플러그인이 있다고 하.. 이전 1 ··· 21 22 23 24 25 26 27 ··· 39 다음
