본문 바로가기
728x90

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

 (129)
WTD 애틀랜틱 2023 - 나도 모르게 문서에서 정보가 노출될 수 있습니다 다양한 내용의 문서화가 중요해지고 온라인상에서 접근할 수 있는 문서가 많아지면서 정보 보안에 관련된 이슈가 생길 수 있습니다. 잘 모르는 곳에서 정보가 새는 상황이 생기기도 합니다. 템플릿은 워드를 기반으로 작성하는 경우를 설명합니다. "dotx"라는 문서 포맷은 처음 들어보는데요. 워드 템플릿 파일이라고 합니다. 구글이나 네이버에서 찾아보면 이게 무슨 파일이야 정도 설명하는 글들만 보이고 실질적으로 이를 템플릿으로 어떻게 쓰는지에 대한 설명은 찾기 힘듭니다. 그만큼 잘 쓰지 않는다는 이야기겠죠. 대부분의 경우에는 문서와 형식을 구분해서 사용하고 있기 때문에 워드 기반의 작업을 하는 곳은 점점 줄어들고 있긴 합니다. 그럼에도 워드를 사용해야 한다면 dotx를 검토해 보는 것도 나쁘지 않겠네요. 스크린샷 ..
WTD 애틀랜틱 2023 - 단일 소스 용어집 구축하기 플랫폼 간에 같은 기능을 설명하기 위해 다른 용어를 사용하는 문제가 있습니다. 이런 문제를 해결하기 위해 다양한 조직 담당자들이 워킹그룹을 만들고 기존에 사용하던 용어, 정의를 모두 정리했습니다. 그리고 모든 토론 과정을 GitHub에 기록으로 남겼습니다. 만들어진 용어집은 다양한 서비스에서 제공되기를 원했습니다. 기술지원포털뿐 아니라 번역 관리 시스템 등에서도 말이죠. 그리고 실제 서비스에서도 용어에 대한 정의를 확인할 수 있어야 했습니다. 이를 구현하기 위해서는 기계가 읽고 처리할 수 있는 단일 소스의 거대한 용어집이 구현되어야 했습니다. Hugo 같은 경우 기능을 확장하기 위해 Modules을 지원하고 있습니다. 그래서 용어집을 Hugo Module로 만들고 이를 각 서비스에서 가져와 사용하도록 구..
WTD 애틀랜틱 2023 - 테크니컬 라이터와 처음 협업해본 UX 전문가의 이야기 Katie Riker는 UX 전문가로 12년 차입니다. 지금은 레드햇에서 일하고 있구요. 10년 차까지는 테크니컬 라이터와 일해본 경험이 없다고 합니다. 그러다가 최근에 새로운 제품을 개발하는 조직에 합류하면서 테크니컬 라이터와 함께 작업을 할 기회가 있었는데 정말 놀라운 경험이었다고 합니다. 그 이유는 UX와 테크니컬 라이팅의 역할(범위)이 비슷하기 때문이라고 생각했답니다. 테크니컬 라이터와의 협업 중 하나는 UI 라이팅 작업입니다. 테크니컬 라이터는 각 제품(서비스) 간 같은 용어를 다른 의미로 사용하는 것을 분석하고 이를 조정하는 작업을 이끌어주었다고 합니다. 아래 그림처럼 표로 만들어서 분석하는 방법이 인상적이네요. 그리고 새로운 용어를 사용하게 되면 이를 정의하고 어떤 과정을 거쳐 만든 용어인지..
WTD 포틀랜드 2023 - 라이트닝 토크 모음 오프라인 행사라서 아마 현장에서도 발표자를 받아서 진행한 것 같습니다. 영상으로 공개된 것이 11개네요. (1) Lightning Talk: Jewel Darger-Sacher - Why :pray: emoji ain't :high-five: 이모지는 어떻게 보면 하나의 표준인데 문화에 따라 다른 의미로 받아들일 수 있다는. 때문에 번역 시에 같은 이모지를 사용하지 않고 필요에 따라 다른 이모지 아니면 다른 텍스트로 번역해야 한다는 겁니다. 참고로 토스에서는 2022년 2월 토스페이스를 공개하면서 일부 이모지를 한국 문화에 맞게 수정했었는데 표준으로 등록된 이모지를 전혀 다른 해석으로 만들어 논란이 되었습니다. 결국에는 표준에 맞게 변경하는 것으로 다시 배포를 했습니다. 관련 기사: https://n.n..
WTD 포틀랜드 2023 - 크라우드 소싱 방식의 문서화 프로젝트 진행하기 이번 발표에서 설명하는 Splunk Lantern이라는 프로젝트의 방식이 좀 낯설어서 전체적인 내용을 제대로 이해하지 못했습니다. 뭐 그럼에도 부족한 자원을 가지고 기여자들과 함께 문서화 프로젝트를 진행하는 여러 팁에 대해 설명하고 있는 것이라서 유익한 팁들만 받아들이면 되지 않을까 싶습니다. Splunk Lantern은 - 공식 제품 문서와 다르게 릴리스 일정과 상관없이 운영됩니다. - 커뮤니티가 아니기 때문에 누구나 문서화에 참여할 수는 없습니다. - 마케팅 지향적인 문서를 만들지 않습니다. - 기술지원 요청에 대응해서 문서를 만들지는 않습니다. Splunk Lantern은 고객을 위한 디지털 셀프서비스 가이드입니다. 현장에서 고객과 함께 일하는 엔지니어들이 자료를 만들고 고객의 성공을 돕습니다. 라..
WTD 포틀랜드 2023 - 대규모 엔지니어 조직에서 생산성 높은 문서화 프로세스 만들기 Datadog에는 12명의 테크니컬 라이터가 일하고 있습니다. 일반적인 개론에서는 1명의 테크니컬 라이터가 10~15명 정도 엔지니어와 함께 일하는 것이 이상적이라고 합니다. 미국 통계에서는 약 30명의 엔지니어를 1명의 테크니컬 라이터가 대응하고 있다고 합니다. 하지만 Datadog에서는 2000여 명의 엔지니어가 일하고 있고 12명의 테크니컬 라이터는 이들 2000여 명의 엔지니어와 매일 커뮤니케이션을 진행합니다. 물론 2000여 명의 엔지니어가 모두 테크니컬 라이터 또는 문서화에 긴밀하게 참여한다고 할 수는 없습니다. 그중에 PM이나 팀 리더와 주로 많은 작업을 합니다. 사내 엔지니어 외에도 고객, 사용자, 파트너, 기술지원, 커뮤니티, 세일즈, 번역을 담당하는 이들과도 함께 일을 해야 합니다. 이..
WTD 포틀랜드 2023 - 포용적인 언어에 대해 이번 세션 주제는 쉽지 않습니다. 발표자의 개인적인 경험을 담고 있고 여러 논쟁이 있는 주제라 그런 것 같습니다. 그래서 발표 전에 몇 가지 규칙을 미리 공지하고 진행합니다. 해당 규칙에 따라(아마 운영진과 합의된 것이 아닌가 싶습니다) Q&A는 진행하지 않았습니다. 주제는 트라우마와 포용적인 언어에 대한 이야기입니다. 트라우마라는 표현은 많이 들어보긴 했지만 실제 경험한 것이 아니라면 공감하기 쉽지는 않습니다. 한국에서는 2018년 국가트라우마센터가 설치됐습니다. 대형 재난에 대한 심리지원이 체계적으로 필요하다는 필요성 때문이었죠. 국가트라우마센터 사이트에서는 트라우마를 다음과 같이 정의하고 있습니다. https://www.nct.go.kr/itaewon/traumaIntro1.do ...트라우마란 재..
WTD 포틀랜드 2023 - 테크니컬 라이팅에 AI 활용하기 발표자는 Rokt라는 전자상거래 관련 솔루션 회사에서 테크니컬 라이터로 일하고 있습니다. 딱히 AI 관련된 기술에 가까이 있는 것은 아니고 개인적인 관심을 가지고 이런 저런 것들을 찾아보고 시도해보았다고 합니다. AI가 일상적으로 쓰인 것이 최근 일인 것 같지만 사실 검색어 입력 시 자동 완성이라든지 맞춤법 검사, 문법 검사 같은 장치들은 꽤 오래전부터 사용하고 있었습니다. 물론 이러한 것들을 의도적으로 쓰지 않는 분들도 있지만요. 기계 번역도 마찬가지입니다. 어떤 방식을 사용하든 AI가 어느 정도 개입하고 있었던 것들이죠. 테크니컬 라이터가 AI를 통해 얻을 수 있는 이점 - 생산성의 향상(반복직인 작업은 AI에게 맡기고 전체적인 문서 구조화 등 작업에 집중할 수 있음) - 콘텐츠 품질 향상(문법, 맞..
반응형

티스토리툴바