본문 바로가기

728x90

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

(117)
WTD 포틀랜드 2023 - 연구자의 글쓰기 대부분의 연구소에서는 문서를 작성하기 위한 전담자가 없고 연구 담당자가 문서를 작성해야 하는데 자신의 업무 중 10% 미만의 시간을 들인다고 합니다. 제목에서 SOP는 표준작업지침서(Standard Operating Procedure)의 약자라고 하네요. 구글 검색에서 SOP라고 찾아보면 무슨 규약 같은 느낌으로 작성되어 있던데 발표자가 이야기하는 것과 같은 것인지는 모르겠습니다. 아마도 실험을 진행하기 전에(새로 합류한 연구원인 경우) 꼭 읽어야 하는 문서라고 하니 맞을 것 같습니다. 하지만 실제 조사를 해보면 SOP를 읽는 비중은 46:53이라고 합니다. 53%는 읽지 않는다는 것이죠(뒤에서 언급하긴 하지만 읽는 것을 확인하는 절차는 있습니다). SOP는 새로운 장비의 영향을 받습니다. 새로운 장비가..
WTD 포틀랜드 2023 - 문서의 '릴리스 레디'는 어떤 상태인가요? 문서화에서 '릴리스 레디'라는 표현은 제품 릴리스 후 24시간 내에 모든 문서와 번역이 완벽하게 완료될 수 있다는 것을 의미합니다. 어찌보면 당연한 거 아닌가 싶기도 한데 제품과 문서가 같은 프로세스를 따라 배포되지 않는다면 문제가 되는 부분이라는 것을 알 수 있습니다. 문서를 코드처럼 다루기랑 비슷한 주제죠. 그래서 이번 발표에서는 안정된 프로세스가 없더라도 '릴리스 레디' 문서 프로세스를 만들 수 있는 팁을 제시합니다. (1) 뭐가 바뀌는지 알기 - 제품팀과 긴밀한 관계를 가지고 계속 커뮤니케이션하는 것이 중요합니다. 궁금한 것은 바로 물어볼 수 있어야 하고 어느 정도의 가시성(신규 개발 일정)을 확보해야 합니다. (2) 규모 확인하기 - 릴리스마다 항상 같은 비중으로 문서가 작성되는 것은 아닙니다...
WTD 포틀랜드 2023 - 테크니컬 라이터로 경력을 이제 막 시작하려는 이들을 위한 여러 조언들 개인 블로그를 통해 10명의 테크니컬 라이팅 관련 업무를 하는 현업을 대상으로 인터뷰를 진행했습니다. 인터뷰 대상을 테크니컬 콘텐츠 크리에이터라고 표현하고 있습니다. https://www.everythingtechnicalwriting.com/tag/interviews/ 인터뷰의 목적 중 하나는 성공한 이들이 어떤 과정을 거쳐서 지금의 자리에 올라왔는지 소개하고 시작하는 이들이 이런 실수를 피할 수 있게 하려는 것입니다. 그리고 어떻게 시작해야 할지 감을 잡을 수 있게 하려는 것이지요. 테크니컬 라이터를 시작하려는 이들이 얻을 수 있는 정보는 어느 곳이나 그렇지만 매우 적습니다. 일부 국가에서는 테크니컬 라이팅 전공이 있는 경우도 있지만 대부분 그렇지 않고 학원 시장에서도 엔지니어 중심의 교육이 이루어지..
WTD 포틀랜드 2023 - 문서를 코드처럼 관리하는 건 항상 쉬운 건 아닙니다 이번 강연은 대충 어떤 이야기인지는 알겠는데 정리가 안되더라구요 ㅠㅠ 그래서 "YouTube & Article Summary powered by ChatGPT"라는 플러그인을 사용해 내용을 요약해 보았습니다. 무서운 세상이네요. 콘텐츠 관리 시스템(CMS)에서 문서를 코드처럼 관리하기로 전환하는 것이 쉽지 않다는 것을 공감합니다. 성공적으로 문서를 코드처럼 관리할 수 있게 하려면 그들을 응원하고 적절한 지침을 제공하는 것이 필요합니다. 문서를 코드처럼 관리하는 장점은 협업, 미리 보기, 통합 워크플로우 등을 이야기할 수 있습니다(물론 요즘 CMS 또는 매뉴얼 저작 도구에서도 이런 것들은 지원하고 있긴 합니다). 조직 내에서 문서를 코드처럼 관리하기로 전환하기 위해 적합성을 평가하고 어느 정도의 비용이 들..
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. 이력서 검토하기 ..

반응형