본문 바로가기

728x90

테크니컬 라이팅

(310)
WTD 포틀랜드 2021 요약 - 오픈 소스 커뮤니티에서 글쓰기를 이끌어내기 Laura Novich는 ScyllaDB 시니어 테크니컬 라이터입니다. ScyllaDB는 Column-family 모델을 사용하는 NoSQL 데이터베이스라고 합니다. 국내에서도 카산드라보다 10배 빠르다는 이야기에 혹해서 관심을 가지고 살펴보는 분들이 있는 듯합니다. ScyllaDB도 오픈 소스다 보니 오픈 소스에서 문서화를 어떻게 다루는지가 주요 초점이 아닐까 싶습니다. Documentation Communities: Sound Strategy or Documentarian's Gambit? https://youtu.be/57ik4zDMKJY 워낙 이전부터 오픈 소스 진영에서 문서화에 참여했던 분이라서 뭐 여러 가지 이야기를 전하고 있지만 그중에서 인상적인 부분은 커뮤니티에서 문서화에 참여하는 이들을 ..
WTD 포틀랜드 2021 요약 - 정보의 연결, 도서관 Paris Buttfield-Addison는 게임 개발자입니다. Secret lab이라는 소규모 개발 팀에서 일하고 있습니다. Unity Game Development Cookbook 등의 책을 저술했는데, 국내에 번역된 책은 없어 보이네요. 개발자가 본업이긴 하지만 역사, HCI 등을 전공하고 역사에 대한 강연을 많이 하고 있어서, 다른 강연에 비해 좀 어렵습니다. Secret lab는 Yarn Spinner라는 유니티 게임 개발 도구를 만든 곳으로 잘 알려져 있다고 합니다. https://yarnspinner.dev/ Yarn Spinner The friendly tool for writing game dialogue. yarnspinner.dev The Secret History of Librari..
WTD 포틀랜드 2021 요약 - IT 기업에 지원하기 전에 테크니컬 라이터가 알아야 할 두세가지 것들 Swapnil Ogale는 Redocly 테크니컬 라이터 애드보케이트입니다. (이번 행사는 유난히 애드보게이트라는 직함이 많네요. 유행인 건가 ㅠㅠ) https://redoc.ly/ 는 API 문서화 서비스를 제공합니다. 국내 개발 관련 글에서도 자주 등장하는 서비스입니다. Putting the "tech" in technical writer https://youtu.be/FQ7DkPOw3Cc 이 분은 2006년부터 다양한 분야에서 테크니컬 라이터로 일했다고 합니다. 소프트웨어 엔지니어링뿐 아니라 금융, 스타트업에서도 함께한 경력을 가지고 있죠. 그런데 작년 어느 테크 회사에 인터뷰를 잘 마치고 뭐 이 정도면 되겠지 싶었는데 아래와 같이 거절 메일이 왔다고 합니다. 뭐 크게 충격받을 내용은 아니지만, 자..
WTD 포틀랜드 2021 요약 - 위키피디아 테크니컬 라이터는 무슨 일을 할까? Sarah R. Rodlund는 위키미디어 재단 개발자 애드보케이트 팀 테크니컬 라이터입니다. 우리가 잘 알고 있는 위키피디아를 관리하는 조직 맞습니다. 2명의 테크니컬 라이터가 있고 개발자들이 만드는 문서에 대한 가이드를 제공하고 수많은 기여자들이 만드는 문서를 관리(?)한다고 합니다. 몇 년전에는 문서화에 대한 전략이 전혀 없었는데 어떤 과정을 거쳐서 전략을 만들고 성숙도 모델을 어떻게 적용하고 있는지 설명합니다. Beyond metrics: Using maturity models to develop a docs strategy https://youtu.be/Ti5lfI0l190 아무래도 간단한 주제는 아니라서 이해하기 어려운 부분들이 많았습니다. 성숙도 모델은 조직이 지금 어디에 있고 어디로 향하고..
WTD 포틀랜드 2021 요약 - 개발자들이 알아서 만드는 API 문서화 Rachael Stavchansky는 Netlify Documentation Team Manager입니다. 네트리파이(Netlify)는 정적 웹사이트 호스팅을 제공하는 서비스입니다. 깃허브 페이지를 많이 사용하고 있지만 네트리파이도 여러 장점 때문에 많은 프로젝트에서 사용하고 있습니다. Shuffle ball change: Sashay your way to clearer API documentation https://youtu.be/aaBLXKGs9cQ API 문서화가 시장에서 주목받고 있는 건 아무래도 수요가 계속 늘어나기 때문입니다. API 시장이 커지면서 개발자도 많아지고 작성해야 할 문서의 범위도 늘어나죠. API 자체를 직관적으로 만드는 것도 중요하지만, 실제 사용에 있어서 문서가 같이 제공되지..
당신만 아는 '당신'의 의미 어제 페이스북에 '당신' 뭐 그런 이야기가 나오길래 뭔지 궁금했지만 찾아보지 않았는데 오늘 아침 뉴스를 보니깐 이런 사건이 있었군요. 기사에도 나오지만 일단 당사자가 해명한 글부터 살펴보죠. 문정복 의원 페이스북입니다. 다음은 류호정 의원 페이스북입니다. 국어사전을 찾아보면 '당신(當身)'이라는 대명사를 찾을 수 있습니다. 류호정 의원은 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 세션 제목은 조부모님이 물려주신 가구에 붙어있는 로고 문구라고 합니다. 구글에서 검색해보면 책장 쪽에서는 좀 유명한 브랜드인가 봅니다. 강연 내용은 뭔가 말은 많은데 요약해보..

반응형