테크니컬 라이팅/WTD 컨퍼런스 (103) 썸네일형 리스트형 WTD 프라하 2022 - 독자와 관계 구축을 통해 문서 개선하기 문서 이해관계자(독자)와의 관계 구축을 통한 콘텐츠 개선하기가 주제입니다. Taylor는 Splunk에서 테크니컬 라이터로 일하고 있습니다. 4년 전 어떤 문서를 개선한 경험에 대해 이야기를 시작합니다. 기존 문서는 뭔가 불편함이 있었다고 합니다(정확하게 어떤 문제였는지는 언급하지 않고 있습니다). 그래서 이런 피드백을 수용하고 개선하기로 결정하고 PM과 어느 정도 범위에서 진행을 할지 협의했다고 합니다. 아래와 같은 점을 수정했습니다. - 태스크 기반 가이드 문서 작성 - 문서, SDK, 예제 저장소에서 사용하는 용어 표준화 - 개발자가 활용할 수 있는 도구, 리소스 소개 - 업데이트되지 않고 정확하지 않은 콘텐츠 제거 프로젝트의 결과로 - 정확하고 최신 코드에 맞는 가이드 문서를 작성했고 - 여러 곳.. WTD 프라하 2022 - Aiven에서는 Lint를 어떻게 사용하나요 Tony Ibbs는 Aiven에서 개발자 교육을 담당하고 있습니다. Aiven는 오픈 소스 클라우드 데이터 플랫폼이라고 하네요. 국내에는 잘 알려지지 않은(검색해 보았을 때) 핀란드 회사입니다. 작년 프라하 컨퍼런스에서는 세션은 담당하지 않고 라이트닝 토크에서 아포스트로피 사용에 대한 짧은 이야기를 전했었네요. 슬라이드를 공개해놓았습니다. 뭐 길지 않은 슬라이드이긴 하지만 ^^ https://github.com/tibs/beyond-spellchecking-talk 문서를 검토하는 가장 좋은 방법은 동료 검토자가 있어서 검토를 요청할 수 있는 것입니다. 하지만 그렇지 않은 경우가 많죠. 조직 내에서 혼자만 문서 업무를 담당하고 있을 수 있고 검토 요청을 하기에는 다들 서로 바쁜 경우엔 그렇죠. 그래서 그.. WTD 프라하 2022 - 마케팅팀과 문서팀이 사이좋게 지낼 수 있을까요 Mano Toth는 오스트리아의 PSPDFKit라는 PDF 솔루션 기업에서 테크니컬 라이터로 일하고 있습니다. 독특하게 케임브리지에서 박사 학위를 받았는데 테크니컬 라이터로 일하고 있습니다. 주제가 마케팅으로서의 문서화인데, 문서 특히 기술 문서에서는 마케팅적인 요소를 가능한 배제합니다. 마케팅은 사실과 완전히 다르지는 않지만 뭔가 사람들을 혹하게 하는 문구들을 사용하는데 그런 부분들 때문에 테크니컬 라이터는 마케팅과 어느 정도 거리를 두고 있습니다(하지만 이건 그럴 것이다라고 대부분의 사람들의 머릿속에 있는 것이죠). Mano는 마케팅과 문서가 서로 갈등 관계에 있다는 증거 중 하나가 대부분의 기술 기업 웹사이트가 문서 사이트와 통합되지 않았다는 겁니다. 기업 웹사이트는 화려하고 SEO를 적용한 반면 .. WTD 프라하 2022 - 밑바닥에서부터 문서팀 만들기 Karissa Van Baulen은 웹사이트 분석 소프트웨어를 만드는 Hotjar에서 기술지원, 콘텐츠 개발, 사용자 교육 등의 업무를 담당하고 있습니다. 현재는 사용자 교육팀 리더라고 합니다. 테크니컬 라이터로 일한 것은 대략 5년 정도 되었구요. 2017년에는 지원팀 전체가 7명이었고 관리하는 문서는 107개였다고 합니다. 이 때는 문서의 소유자가 명확하지 않아서 문서 유지 관리가 제대로 되지 않았던 시기였습니다. Karissa가 기술지원 조직으로 입사를 한 것이 2017년 4월이었는데 이런 상황을 참지 못하고 문서 담당자가 되기로 했다고 합니다. 그 이전 경력을 보면 디자이너, 제품 매니저 등의 업무를 담당했지만 테크니컬 라이터로서 일한 적은 없습니다. 좀 독특한 케이스네요. 그런 결심을 하고 당연.. WTD 프라하 2022 - 문서화를 가로막는 6가지 것들 Emilia Juda Özbay는 블룸버그 테크놀로지 엔지니어입니다. 사내 개발자를 위한 개발도구를 만들거나 지원하는 업무를 담당하고 있어 문서화 도구도 마찬가지입니다. 블룸버그 테크놀로지에서 기존 자바스크립트 기반 환경을 타입스크립트로 변경하기로 결정했습니다. 코드 전환은 물론 배포 환경까지 바뀌어야 하는 커다란 인프라 변경이었지요. 이왕 바꾸는 김에 문서화 시스템도 같이 변경하기로 하고 현재 시스템의 pain point 6가지를 조사합니다. (정확하게는 조사한 건 아니고 이런 저런 자료들을 참고해서 6가지를 선정한 것 같습니다. 참고한 자료는 이런 것들입니다). - Library Evaluation Rankings 자바스크립트 라이브러리 선택 시 어떤 것을 먼저 보는지에 대한 질문인데 1위가 Doc.. WTD 포틀랜드 2022 - 라이트닝 토크 모음 Sarah Shockey - Global English: tips and tricks for simplicity and cross-cultural communication Sarah Shockey는 showpad라는 판매 지원 소프트웨어 기업에서 테크니컬 라이터로 일하고 있습니다. showpad의 본사는 벨기에인데 독일, 영국, 폴란드, 네덜란드, 미국에 각각 오피스를 가지고 있네요. 그래서 영어 기반으로 일하고 있지만 누구나 쉽게 이해할 수 있는 글로벌 영어를 사용한다고 합니다. Help center의 자료들이 주로 작성하는 문서인데 영어로 문서를 작성하면서 경험한 것을 공유합니다(해당 사이트는 영어, 프랑스어, 독일어로 제공됩니다). https://help.showpad.com/ 뭐 이런 내용입니다만.. WTD 포틀랜드 2022 - 밋업을 만들고 참여해봅시다 개인적인 정리 WTD 밋업 코디네이션 팀에 대한 이야기입니다. Rose Williams는 팀을 리드하고 있고 starburst라는 회사에서 인포메이션 엔지니어로 일하고 있습니다. Alyssa Rock은 VMware에서 테크니컬 라이터로 일하고 있구요. Quorum meetup 프로그램을 운영하고 있습니다. Quorum meetup은 줌 기반으로 온라인 상에서 진행되며 코로나 이후 새롭게 진행하는 프로그램이라고 합니다. https://www.writethedocs.org/team/#meetups https://www.writethedocs.org/meetups/index.html#current-meetups-quorum https://github.com/write-the-docs-quorum/quorum-.. WTD 포틀랜드 2022 - 테크니컬 라이터와 개발자의 협업에 대해 개인적인 정리 원래 이름은 Ian Dees였습니다. Ian Dees라는 이름으로 테스팅 관련 분야에서 꽤 많은 책을 쓴 것을 찾아볼 수 있습니다. https://www.amazon.com/Ian-Dees/e/B002BM9GLE 개인 스타일링 서비스를 제공하는 스티치 픽스(STITCH FIX)라는 곳에서 2019년부터 소프트웨어 엔지니어로 일하고 있습니다(라고 이력서에는 나와있는데 발표를 보니 briza.com에서 일한다고 합니다). Cowpoke는 카우보이를 뜻하는 미국식 구어라고 합니다. Wrangler도 카우보이인데 주로 목장 내에서 말을 돌보는 일을 하는 이들을 뜻한다고 합니다. Cowpoke는 외근직, Wrangler는 내근직이라고 할 수도 있겠네요. 개발자와의 협력을 강조하며 여러 가지 장점을 .. 이전 1 ··· 5 6 7 8 9 10 11 ··· 13 다음
