본문 바로가기

728x90

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

(114)
WTD 애틀랜틱 2023 - IA 개편 프로젝트 실패 공유 기존 문서는 이해하기 어렵고 원하는 정보를 찾기가 어려웠다고 합니다. 그래서 전반적인 정보의 재구성이 필요한 상황이었습니다. consul이라는 솔루션에 대한 문서가 2가지 형태로 나누어져 있었습니다. 하나는 Learn이고 하나는 docs입니다. 도메인 자체가 따로 나누어져 있기 때문에 서로 정보를 연결하기도 쉽지 않았습니다. 물론 이런 문제는 서비스를 하나로 통합하면 되는 것이라서 큰 문제는 아니었습니다. 정보를 재구성하는데 있어서 콘텐츠 자체를 다시 작성하는 것은 대응할 수 있는 규모가 아니었기 때문에 이를 배제하고 정보를 재구성하는 것에만 집중하기로 했습니다. 콘텐츠를 분류하고 정해진 주제에 따라 정보를 재배치했습니다. 탐색바부터 시작해서 사용자가 원하는 정보를 최소한의 클릭으로 찾을 수 있게 제공하..
WTD 애틀랜틱 2023 - 문서 작성자를 위한 OpenAPI 나름 시각화를 통해 설명을 시도한 것은 좋았으나 뒤로 가면서 OpenAPI에 대해 점점 더 알기 어렵게 설명하는 것이 아닌가 싶습니다. OpenAPI 문서화는 문서 작성자가 따로 없더라도 어느 정도 형식을 갖추어 만들 수 있기 때문에 문서 작성자에게는 기회가 될 수도 있지만 딱히 그렇지 않을 수도 있습니다. ChatGPT 같은 AI 글쓰기 도구를 활용하는 곳이 늘어난다면 그 자리는 더 줄어들 수 있구요. API 설계 초기부터 문서 작성자가 참여해야 한다는 이야기도 있는데 도메인이나 기술을 제대로 알지 못하면 소용이 없습니다. 물론 계속해서 참석하면서 쌓아갈 수는 있지만요. 당장 뭔가 내가 기여해야 한다는 압박을 가질 필요는 없습니다. OpenAPI 관련 도구들이 정리된 곳입니다. 꽤 많은 목록이 정리되어..
WTD 애틀랜틱 2023 - AI 도구를 윤리적으로 사용하려면 생성형 AI 도구를 사용해 기술 문서를 작성할 때 가장 큰 문제는 잘못된 정보(또는 허위로 작성된 정보)를 가져올 수 있다는 겁니다. 하지만 이런 문제는 AI가 아니라 잘못 작성된 사이트 정보를 참고하거나 누군가 잘못 알려준 정보를 사용할 때도 마찬가지입니다. 어떤 정보를 사용하든 이를 확인하는 책임은 문서 작성자에게 있기 때문에 이걸 윤리적인 문제라고 보는 것은 좀 애매할 듯합니다. 저작권 같은 정보도 마찬가지구요. 테크니컬 라이터가 도구를 사용해 문서를 작성하는 경우에는 그나마 중간에서 이를 확인할 수 있는 여지가 있습니다. 하지만 사용자의 질문에 답해주는 시스템을 만들었다고 생각해 보죠. 이런 경우에는 학습을 통해 고도화를 시킬 수는 있지만 답변의 내용을 하나하나 확인할 수는 없습니다(가능은 하겠지..
WTD 애틀랜틱 2023 - 스크린샷이 왜 중요한가요? launch brightly라는 솔루션을 만드는 회사의 창업자입니다. launch brightly라는 것이 제품 스크린샷을 자동으로 처리해 주는 솔루션이네요. 이번 세션은 본격 광고 세션입니다(라고 생각했는데 제품 이야기는 하지 않고 스크린샷에 대한 기본적인 이야기만 다룹니다). 독특하게 꽤 여러 회사를 창업한 후 다른 회사에 팔고 엑시트 하는 분이네요. 1996년부터 5번의 엑시트를 경험했습니다. launch brightly는 2022년 8월에 시작해서 이제 막 1년이 넘은 솔루션입니다. 아직 매각 소식은 없습니다. 세션 전반부는 왜 이미지가 중요한지 강조합니다. 뭐 다들 아는 내용이지만(사실 한국에서는 문서에 이미지를 좀 과도하게 사용하는 경향이 있고 영어권에서는 그렇지 않습니다. 가능하면 문장으로 ..
WTD 애틀랜틱 2023 - 사용자가 원하는 일을 할 수 있는 문서 만들기 발표자의 커리어가 독특한데요. 4년 정도 기자(잡지 에디터) 생활을 하고 마케팅 쪽 기술 콘텐츠를 작성하는 일을 8년간 하다가 제품 문서를 작성하는 일을 2020년부터 하게 되었다고 합니다. 학문적인 배경은 영미문학철학박사 학위를 가지고 있습니다. 이런 경험을 통해 콘텐츠에 대한 사용자의 참여를 중요하게 여기게 되었다고 합니다(아무래도 제품 문서만 만들면 사용자에 대해 민감하게 반응하지 않는데 잡지나 마케팅 콘텐츠를 다루면서 사용자에 대한 다양한 경험을 쌓았다고 강조하는 듯합니다). 대부분의 문서화 평가 지표를 보면 사용자보다는 비즈니스 측면에서 지표를 만듭니다. 때문에 그런 지표들이 사용자가 진짜 원하는 것을 가져다주는 것은 아니죠. 문서의 목적은 사용자가 원하는 작업을 빠르게 처리하고 문서를 떠나는 ..
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 저장소에 문서를 커밋할 때 가독성 점수를 체크하고 이전 문..

반응형