본문 바로가기

728x90

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

(129)
WTD 포틀랜드 2023 - 사용자 피드백을 가지고 문서 개선하기 Ryan Young은 스트라이프 테크니컬 에디터입니다. 스트라이트에서 사용자 피드백을 가지고 어떻게 문서화를 개선했는지 설명합니다. 스트라이프 문서는 사용자가 피드백을 제공할 수 있는 기능을 지원합니다. 이런 피드백을 기반으로 사용자가 작업을 수행하기 위해 필요한 다양한 기능을 추가하고 있습니다. 그럼에도 계속 사용자의 불만은 늘어갔습니다. 그래서 피드백을 천천히 들여다보기 시작했습니다. 그중 하나가 "너무 많은 옵션(Too many options)"을 제공한다는 것이었습니다(문서 시스템의 기능을 이야기하는 건 아니고 제품 자체에서 다양한 옵션을 제공하는데 그런 옵션 설명이 흩어져있다는 것입니다). 그래서 사용자가 필요한 작업을 수행하기 위해 살펴봐야 하는 문서의 내용이 한 곳에 있지 않고 여러 곳에 흩..
WTD 호주 2022 요약 - 라이트닝 토크 모음 Cameron Shorter - My Open Source Docs Addiction https://youtu.be/S-6NxPUorgU 오픈소스에 참여하면 얻을 수 있는 것들 - 영향력을 넓힐 수 있습니다. - 아무도 여러분을 방해하지 않습니다. 원하는 걸 다 해볼 수 있죠. - 커뮤니티에 참여하면서 다양한 경험을 할 수 있습니다. 뭐 물론 오픈소스 커뮤니티라고 해서 다 깔끔한 건 아닙니다. 심지어는 정치적인 다툼도 있구요. 뭔가 발표가 어설퍼보이지만 이 분은 구글 테크니컬 라이터이면서 제품 관리자입니다. 구글에는 2020년 합류했고 그 이전에는 다양한 기업에서 엔지니어, 테크니컬 라이터로 일했습니다. 1987년에 학위 과정을 시작했으니 대략 50대 중반이시겠네요. Gaurav Nelson - Unlo..
WTD 호주 2022 - PLG 전략과 기술 문서 Alex Fiedler는 Torq라는 사이버 보안 플랫폼 기업에서 지식 경험 부문을 담당하고 있습니다. PLG는 Product-Led Growth의 약자라고 합니다. 우리말로 번역하면 제품주도성장이라는 의미라고 합니다. Wes Bush의 책 "Product-Led Growth: How to Build a Product That Sells Itself"에서 시작된 표현이라고 하네요. 2019년에 나온 책인데 이 책이 번역되지 않은 것은 좀 신기하네요. https://productled.com/book 에서 온라인으로 내용을 볼 수는 있습니다. PLG 전략이 새로운 것은 아니지만 최근 테크 기업에서 많은 관심을 받고 있고 그 영향력을 넓혀가고 있습니다. 지식 경험이라는 표현은 좀 낯설 수 있는데요. 지식은 ..
WTD 호주 2022 - 처음 인터뷰어로 참여하는 이들을 위한 팁 Ishara Ilangasinghe는 개발자로 경력을 시작했고 테크니컬 라이팅 업무에 관심을 가지고 현재는 테크니컬 라이터로서 일하고 있다고 합니다. WSO2라는 오픈소스 API 관리 플랫폼을 개발하는 기업에서 테크니컬 라이터로 일하고 있습니다. 테크니컬 라이터 지원자를 인터뷰하는 인터뷰어로서 첫 경험을 공유합니다. 첫 인터뷰를 준비하면서 인터뷰어의 관점에서 자료를 찾아보았지만 정보가 거의 없었다고 합니다. 인터뷰이 관점에서 인터뷰를 준비하기 위한 리소스는 많지만 그 반대는 찾기 힘들다는 것입니다. * 테크니컬 라이터 지원자를 위한 인터뷰라는 제목이지만 딱히 테크니컬 라이터 지원자가 아니더라도 적용할만한 내용입니다. 그렇게 보면 리소스가 그리 적지는 않을 텐데 말이죠. 인터뷰 준비 1. 이력서 검토하기 ..
WTD 호주 2022 - 표준에 따라 기술 문서 작성하기 Shumin Chen은 싱가포르의 shufrans-techdocs라는 기술문서 전문 기업에서 STE(Simplified Technical English) 업무를 담당하고 있습니다. STE는 ASD-STE100라는 스펙으로 정의되어 있습니다. 2019년 출간된 "테크니컬 라이터가 되려는 당신에게"에서 간략하게 ASD-STE100를 소개하는 내용이 포함되어 있었습니다. WTD에서는 주로 소프트웨어 산업의 기술 문서를 중심으로 다루다 보니 국제 표준에 대한 언급은 많이 없었는데 이번 세션에서는 최근 국제 표준 관련 트렌드에 대해 다루고 있습니다. 문서화의 중요성에 대해서는 많은 산업에서 강조되고 있지만 표준에 대해서는 무시되는 경향이 있습니다. ASD-STE100 같은 표준을 따르는 것은 테크니컬 라이터, 독..
WTD 호주 2022 - 문서가 해커 공격의 매개체가 될 수 있다 Lilly Ryan은 독특한 커리어를 가지고 있습니다. 역사 전공으로 중세 유럽의 감시 시스템을 연구하다가 소프트웨어 엔지니어가 되었습니다. 현재는 Thoughtworks에서 보안 전문가로 일하고 있습니다. 자신이 진행하는 인터뷰 채널에 Heidi Waterhouse(Docs for Developers의 저자 중 한명)가 참여해 보안 전문가들과 테크니컬 라이터가 일하는 방식에 대해 이야기했는데 그때 얻은 아이디어를 바탕으로 강연을 진행한다고 합니다. 예를 들어 보안 전문가가 침투 시험(Penetration test)를 진행할 때 취약점을 찾기 위해 문서를 샅샅이 읽습니다. 문서를 읽는 방식은 두 가지입니다. 첫 번째는 일반 사용자들과 마찬가지로 소프트웨어의 사용법(어떤 작업을 수행하는 방법)을 알기 위해..
WTD 호주 2022 - 커뮤니티 주도 문서화 프로젝트 이끌기 Sarah Rainsberger는 오픈소스 프로젝트 astro의 문서 작성 책임자입니다. astro에 합류하기 전에는 교육계에서 일했다고 합니다. 과외 같은 수업도 진행했는데 커뮤니티 주도로 문서를 작성하는 astro에서는 그런 역할이 필요했나 봅니다. 가이드를 제공하고 작성한 글을 첨삭해 주는 역할입니다. https://docs.astro.build/en/getting-started/ 문서가 기술적으로 정확한 것만으로는 충분하지 않습니다. 문서는 커뮤니티의 요구를 충족시켜야 합니다. astro는 커뮤니티 주도로 문서를 작성합니다. 여기에는 3가지 원칙이 있습니다. 협업, 적용, 참여입니다. - 협업 깃헙을 통해 문서 소스 코드를 공개하고 문서화 프로세스를 확인할 수 있습니다. 그리고 어느 정도 문서화가..
WTD 호주 2022 - 테크니컬 라이터로 성장하기 위해 필요한 이론적인 지식들에 대해 Lana Novikova는 젯브레인에서 테크니컬 라이터로 일하고 있습니다. 젯브레인에서는 writerside라는 기술 문서 작성을 위한 솔루션을 만들었고 현재 일부 사용자에게 공개 중입니다. 10년 차 테크니컬 라이터이며 테크니컬 커뮤니케이션에 대한 멘토링도 하고 있습니다. 학생들을 좀 더 잘 가르치기 위해 인지 심리 등 필요한 이론적인 지식을 따로 시간을 내 배우고 있습니다. 이번 영상은 아마도 이런 학습 과정에서 배운 것들을 문서화와 연결해서 설명하는 부분입니다. 좀 더 많은 자료는 UX 또는 UX Writing 이나 교육 쪽에서 많이 찾아볼 수 있습니다. 교육 분야는 워낙 오랫동안 연구된 분야이기도 하고 UX의 경우는 리학이나 다른 분야에 있던 분들이 UX 쪽 연구에 합류하면서 만들어진 자료가 많아..

반응형