본문 바로가기

728x90

테크니컬 라이팅/WTD 컨퍼런스

(117)
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 자체를 직관적으로 만드는 것도 중요하지만, 실제 사용에 있어서 문서가 같이 제공되지..
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도 그렇고~ 에반젤리스트는 기술에 집중한다면 애드보케이트는 좀 더 사용자에 집중하는 느낌입니다. 튜토리얼을 공식적으로 테크니컬 라이터가 작성하기도 하지만, 발표자의 주요 업무(?) 중 하나가 개발자의 문제 해결을 위한 튜토리얼 작성이라고 합니다. 레퍼런스 가이드는 각각의 기능을 설명하지만, 특정 문제에 대한 해결책을 안내하지는 않습니다. 문제 해결을 위해서는 다양한 기능 요소들을 적절하게 조합하고 풀어내는 것이 필요한데 그런 일은 주로 커뮤니티에서 콘텐츠를 많이 만들어내고 있죠. 하지만 개발자 애드보케이트가..

반응형