본문 바로가기

728x90

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

(117)
WTD 애틀랜틱 2023 - 어떻게 복잡한 기술을 쉽게 전달할까 스플렁크에 합류하고 나서 오픈텔레메트리에 대한 이야기를 PM과 했습니다. PM은 자신도 오픈텔레메트리를 이해하는데 6개월 이상이 걸렸다고 하소연을 합니다. 그럼 나(테크니컬 라이터)는 어떻게 이 기술을 이해할 수 있을까요? 오픈텔레메트리 웹사이트는 여기입니다. https://opentelemetry.io/ 나름 한국어로 된 쉬운 자료는 제니퍼소프트에서 발행한 글을 참고하세요. https://jennifersoft.com/ko/blog/tech/opentelemetry/ 하지만 이런 자료들을 테크니컬 라이터 입장에서 보면 이런 기분이라고 합니다. 이게 뭐야 싶은 거죠. 기술을 제대로 이해하려면 엔지니어의 경우에는 오랜 시간의 수련이 필요합니다. 하지만 테크니컬 라이터처럼 기술을 가지고 뭔가 하려는 것은 아..
WTD 애틀랜틱 2023 - Antora를 사용한 문서화 파이프라인 발표는 레드햇 테크니컬 라이터 Fabrice Flore가 진행했는데 운영 환경 관련 내용으로 바로 들어가서 기본 배경이 없다면 갑자기 저 사람은 누구인데 저건 또 무슨 이야기인가 싶습니다. Q&A에서도 그렇긴 하지만 뭔가 말을 좀 길게 하는 편이라서 어떤 이야기를 하고 싶은 건지 딱 명확하게 짚어내기가 어렵네요. 이 분 경력을 보면 2000년부터 개발자로 시작해서 테크니컬 라이터로 일하기 시작한 건 2019년부터입니다. 어떤 경로인지는 모르겠으나 이클립스 커미터로 합류하면서 문서화 엔지니어링 쪽에 참여하신 듯하구요. 그러면서 레드햇 쪽 일도 같이 한 것 같네요. 정확하게는 테크니컬 라이터보다는 도큐먼트 엔지니어 쪽이 좀 더 가까운 표현이 아닐까 싶습니다. 전반적인 내용은 콘텐츠 재사용에 대한 이야기입니다..
WTD 애틀랜틱 2023 - 가독성 지표 기반 문서화 지난 2년간 적용해 본 가독성 지표 기반 문서화에 대해 설명합니다. 이번 강의를 위해 오픈소스 도구도 만들었다고 하네요. 가독성 지표를 도입한 이유는 독자들의 인지 부하를 줄이기 위함이었다고 합니다. 2년 전에는 테크니컬 라이터나 스타일 가이드 없이 제각각 만들어진 문서가 있는 상태여서 이를 전반적으로 개선하고 문서화 작업을 다시 진행해야 했습니다. 이 과정에서 리뷰어의 참여가 중요한데 리뷰어(개발자)들의 인지 부하를 줄이면 좀 더 효율적으로 작업하 수 있을 것이라 판단했다고 합니다. 기존 CMS 도구를 사용할 수도 있었지만 가독성을 평가하기 위한 데이터 수집에 최적화된 도구가 필요했기 때문에 직접 도구를 만들어 사용하기로 했습니다. GitHub 저장소에 문서를 커밋할 때 가독성 점수를 체크하고 이전 문..
WTD 애틀랜틱 2023 - 문서 구조화에 대한 생각 북미의 아파트 정책이 슬럼화된 것이 하향식 정책이 만들어낸 대표적인 실패라고 언급하고 있습니다. 도시를 설계할 때 거주자의 시선이 아니라 하늘에서 바라보는 새의 시선으로 만드는 것이 문제였다고 합니다(물론 독특하게 한국에서는 성공을 했지만 시간이 지나면 한국도 슬럼화가 될 수 있다는 경고도 있네요). 정보를 디자인하는 것도 마찬가지입니다. 일반적으로 사이트를 구성하는 방식은 트리 구조입니다. 루트가 있고 그 아래에 가지를 뻗어서 정보를 배열합니다. 고전적인 방법이고 누구나에게 익숙한 것이죠. 하지만 실제 독자가 정보에 접근하는 것은 트리를 따라 접근하는 것이 아닙니다. 테크니컬 라이터로 조직에 처음 합류하게 되면 온보딩 코스 대신 문서만 받고 이를 실제 활용해 보는 것을 추천합니다. 실제 독자의 입장에서..
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..

반응형