본문 바로가기

728x90

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

(117)
WTD 포틀랜드 2022 - 콘텐츠 재사용 시 유의할 점은 어떤 것이 있나요? 개인적인 정리 Anna Gasparyan는 JetBrains 입사 8년 차입니다. 테크니컬 라이터로 시작해서 2020년부터는 PM을 담당하고 있습니다. 자신의 이력을 모자로 표현한 일러스트가 인상적입니다. 테크니컬 라이터 경력은 약 15년이라고 합니다. (내부 문서 작성 및 배포 시스템 개발을 담당하고 있는 듯 한데 상용으로 공개된 제품인지 내부에서 쓰는 것인지 명확하지는 않습니다). (Writerside라는 제품을 준비하고 있네요. 아직은 공개전이긴 합니다). https://lp.jetbrains.com/writerside/ JetBrains은 다양한 언어와 기능을 지원하는 개발 도구를 만들고 있는데요. 각 개발도구는 공통적인 기능이 있고 특화된 기능이 있습니다. 12개의 개발 도구를 만든다면 문서 역..
WTD 포틀랜드 2022 - 혼자 일하다가 우울해지면 어찌하나요? 개인적인 정리 Kate Mueller는 KnowledgeOwl에서 Product & Customer Champion으로 일하고 있습니다. Champion이라고 해서 마이크로소프트 MVP 같은 커뮤니티인가 싶었는데 뭔가 이 회사는 스탭 이름을 각자 맘에 드는 방식으로 붙이는 듯합니다. 세션 제목이 Beating the Virginia Blues: Thru-hiking strategies for your next big project인데 일단 2가지 용어가 낯선 것이라 ~ 이에 대한 설명을 한참 합니다. 뭐 그런 거 다 아는 거다 싶다면 7분 정도부터 보세요. Thru-hiking은 종주 하이킹이라고 번역하는데 몇 달에 걸쳐 하이킹을 하는 것이라고 하네요. 종주 하이킹을 위한 코스가 여러 가지가 있는데 그중..
WTD 포틀랜드 2022 - 바닥부터 문서 팀 만들기 개인적인 정리 Lana Brindley는 Timescale의 문서 관리자라고 합니다. Red Hat, OpenStack, SUSE 등 다양한 기업을 거쳐 Timescale에는 2021년 합류했습니다. Timescale은 시계열 데이터에 대해 SQL을 확장하고 분석하는 도구라고 합니다. 2018년 시작한 회사이고 이쪽 분야에서는 독보적인 기술을 보유한 듯합니다. 앞에서 화려한(?) 경력을 가지고 있다고 설명했는데 정확하게 어떤 회사인지는 말하지 않지만 이 정도 규모의 문서 팀에서 일했다고 합니다. (1) 4명에서 시작해서 14명까지 (2) 2명에서 시작해서 9명까지 (3) 오픈소스 커뮤니티 (다수명) (4) 1명에서 시작해서 2명 (스타트업. 회사 망함) (5) 1명에서 시작해서 현재 3명(Timescal..
WTD 포틀랜드 2022 - 테크니컬 라이터 온보딩 프로그램으로 짝 글쓰기 활용하기 개인적인 정리 Chris Ganta는 아틀라시안 테크니컬 콘텐츠 디자이너입니다(하는 일을 보면 테크니컬 라이터와 다르지 않은데 디자인 조직 내 속하다 보니 그렇게 이름을 붙이는 것이 아닌가 싶네요). 아틀라시안에는 올해 1월 합류했고 이전에는 다양한 기업에서 테크니컬 라이터로 활동했습니다. Peer writing - "Two Heads are Better than One". And we got more than two Anyone can fall into a creative rut from time to time, but it is rare for two people to do so concurrently. 오픈소스 프로젝트에서 전문적인 테크니컬 라이터가 아닌 이들이 어떻게 문서화 작업에 성공적으로 안착..
WTD 포틀랜드 2022 - 구글은 문서를 어떻게 평가할까? 제목은 낚시였습니다. 정확하게 이야기하면 평가 지표 등은 오픈소스 프로젝트 조직에서 결정하는 것이고 구글은 이를 지원하는 역할만 하는 거라서~~ 개인적인 정리 Season of Docs 프로그램은 2019년 시작됐습니다. 그때는 테크니컬 라이터 Sarah Maddox와 오픈소스 담당자 Andrew Chen가 진행을 했었다고 합니다. https://opensource.googleblog.com/2019/03/introducing-season-of-docs.html 초기에는 오픈소스 운영자에게 좋은 문서를 더할 수 있는 기회를 제공하고 테크니컬 라이터에게는 오픈소스 프로젝트에 참여할 기회를 주는 것이죠. 운영 방식 아이디어는 Summer of Code에서 가져왔는데 Summer of Code는 멘토링에 초점..
WTD 포틀랜드 2022 - Runbook과 기술 문서는 무슨 차이가 있을까? 개인적인 정리 Shane Diven는 2018년부터 Alastair Dallas는 2019년부터 Splunk에서 테크니컬 라이터로 일하고 있습니다. Splunk는 2003년 설립되어 7500명 정도가 일하고 있는데 사용자의 플랫폼을 24시간 모니터링하는 서비스를 제공하는데 문제가 생겼을 때 내부 엔지니어는 Runbook을 참조해 대응하게 됩니다. 그래서 오늘의 주제는 "Runbook"입니다. 한국어로는 적당한 번역이 없는데 IT용어대사전에서는 "실행서"라고 표현하고 있네요. 프로세스 자동화에서는 Runbook을 작업 시나리오의 의미로 사용하고 있는데 이번 세션에서는 실제 작업자가 수행해야 하는 작업 가이드라고 이해하면 될 듯합니다. 이번 세션은 이런 테크니컬 라이터를 위한 내용으로 구성했다고 합니다. A..
WTD 포틀랜드 2022 - 문서에서 사용하는 코드를 단위 테스트하는 방법 개인적인 정리 Ben Perlmutter는 MongoDB Realm 문서 팀에서 일하고 있다고 합니다. Realm(렘)은 데이터 동기화 기술을 가진 기업으로 2019년 MongoDB에서 인수했더군요. 2017년부터 MongoDB에서 일을 시작했습니다. 간단하게 Realm이라는 것이 뭔지 설명해주며 시작합니다. 모바일 기기에 데이터를 저장했다가 서버와 동기화해주는 거라고 하네요. 요즘은 거의 모든 기기가 네트워크에 연결된 상태라 그럴 필요가 있나 싶지만 뭐 환경에 따라 그럴 수 있으니. 사이트 설명을 보면 SQLite을 대체하는 솔루션이라고 하네요. https://realm.io/ 문서 내에 포함하는 코드는 주로 사용자가 해당 코드를 복사해서 바로 사용하거나 약간의 수정 후 사용할 수 있게 구성되어 있습니..
WTD 포틀랜드 2022 - AWS 문서화팀 이야기 개인적인 정리 놀랍게도 AWS에서 2020년까지는 문서 작업을 마이크로소프트 워드 기반으로 진행했다고 합니다(일부 팀만 그렇게 했다는 건지 아니면 AWS 전체를 이야기한 건지는 명확하지 않습니다. 하지만 발표자인 Marcia Riefer Johnston가 아마존에 합류한 것이 2019년이고 Integration & Automation 팀으로 옮긴 것이 2020년 3월이라 기존에 문서를 코드처럼 다루거나 자동화하는 프로세스가 없었을 수도 있습니다). 코드 기반으로 문서를 전환한 것은 2020년 중반에 시작한 일입니다. * 개인적으로는 DOCS AS CODE가 정답이라고는 생각하지 않습니다. DOCS AS CODE의 장점을 살릴 수 있는 도구라면 대안으로 선택할 수도 있습니다. 특히 문서를 작성하는 팀이 문..

반응형