본문 바로가기

테크니컬 라이팅

 (433)
WTD 포틀랜드 2025 - 라이트닝 토크 모음 (1) Zaz Linkous: Game design in documentation 게임을 만들 때 마리오 1.1 이라는 것이 있다고 합니다(검색해 보면 World 1-1이라고 나옵니다). 게임을 시작할 때 안전한 환경에서 게임 조작법을 익히는 레벨입니다. 게임 디자인의 교과서 같은 것이라고 하네요. https://en.wikipedia.org/wiki/World_1-1하지만, 기술 문서에서는 World1-1같은 안전한 공간이 없습니다. 처음부터 혼돈의 세계에 던져지는 상황이 많죠. 때문에 게임 디자인의 원칙을 공부하면 좀 더 사용자가 안전한 환경에서 제품에 접근하도록 가이드할 수 있습니다(실제 클라우드 서비스 같은 경우에는 동작을 배우기 위해 비용이 들어가는데, 튜토리얼 같은 문서에서는 별도의 비용 없이 따라 ..
WTD 포틀랜드 2025 - 커뮤니티와 같이 문서 만들기 Discord의 시니어 개발자 에반젤리스트 Colin Loretz가 문서를 누구나 기여할 수 있도록 '오픈'하고, 커뮤니티와 PR 중심으로 협업하며 얻은 교훈과 실질적 운영 노하우를 공유합니다. Discord는 오픈소스 제품은 아니지만, 문서는 공개된 GitHub 저장소에서 관리하며, 매달 30~50건의 PR 중 절반 이상이 커뮤니티에서 올라올 만큼 활발한 협업이 이루어지고 있습니다.https://github.com/discord/discord-api-docs 1. 오픈 문서의 의미와 효과 - 문서를 오픈하면 개발팀과 사용자와의 '공동 창작' 및 '공동 소유' 관계가 형성됩니다. - Discord는 공식 SDK 외에도 60개 이상의 커뮤니티 라이브러리(20개 이상 언어)를 지원하며, 이 생태계가 문서에 ..
WTD 포틀랜드 2025 - 경쟁 분석을 통해 기술 문서 개선하기 이 발표에서 Leah Catania(Insulet의 시니어 콘텐츠 전략가)는 테크니컬 라이터와 콘텐츠 전략가가 "경쟁사 분석(Competitive Analysis)"을 활용해 문서 전략을 개선하고, 이해관계자(stakeholder)의 신뢰와 동의를 얻는 실질적인 방법을 공유합니다. 실제 경험과 구체적인 사례를 바탕으로, 경쟁사 분석의 준비, 실행, 결과 활용, 설득 전략까지 단계별로 설명합니다.(간혹, 실제 업무는 테크니컬 라이터인데 콘텐츠 전략가라고 소개하는 경우도 있는데, Insulet의 경우에는 테크니컬 라이터, UX 테크니컬 라이터, 콘텐츠 전략가 이런 식으로 상당히 세분화되어 팀을 구성하고 있습니다. 의료기기를 다루는 업체 특성인 것 같기도 합니다).1. 경쟁사 분석이란 무엇인가? 경쟁사 분석은..
WTD 포틀랜드 2025 - 조직 규모에 따라 테크니컬 라이터가 하는 일이 달라지나요 발표자는 현재 회사(Klaviyo)에 2019년 합류했는데 그 시점에 전체 구성원은 350명 정도였고 테크니컬 라이터는 3명이었다고 합니다. 이때는 스타트업 규모였고 테크니컬 라이터의 역할은 기술 문서뿐 아니라 온보딩, 마케팅, 블로그 관리 등 여러 가지 필요한 일들을 다 했어야 했습니다. 이 시기에 만든 콘텐츠 중에 사용자들이 주로 겪는 사례들을 FAQ 형태로 만든 콘텐츠가 300여개300여 개 정도 있었습니다. 하지만 여러 가지 일을 해야 하는 3명의 테크니컬 라이터에게는 관리하기 어려운 짐이 되어버렸습니다. 그런데 마침 외부 개발자 커뮤니티를 만드는 팀이 있었는데 그 팀에는 부족한 콘텐츠가 문제였습니다. 우리가 가지고 있는 300여 개의 부담스러운 콘텐츠는 그들에게 커뮤니티 게시물을 늘릴 수 있는 ..
WTD 포틀랜드 2025 - 서로 다른 조직의 문서를 하나로 합치기 Ping Identity는 기업용 아이덴티티, 액세스 관리를 서비스하는 기업입니다. 근무하는 인원은 약 2500명인데, 테크니컬 라이터가 32명이라고 합니다. 여기에 2명의 에디터가 있고, 4명의 콘텐츠 엔지니어, 3명의 관리자가 있다고 합니다. 회사 규모에 비해 상당히 많은 인원이고, 에디터가 있다는 것이 정말 대단한 일입니다. 발표자는 럭셔리한 환경이라고 표현하네요. 2023년에 비슷한 일을 하는 ForgeRock을 인수했는데, 문서팀에는 2가지 전혀 다른 문서화 프로세스를 통합해야 하는 미션이 생겼습니다. Ping은 DITA 기반으로 문서를 작성하고 있었고, ForgeRock은 Docs as Code 형식으로 관리하고 있었습니다. 전혀 다른 형식이라 어느 한쪽으로 프로세스를 정해야 했고 Docs a..
WTD 포틀랜드 2025 - 모두가 탄탄한 길로만 가는 것은 아닙니다 개인적으로는 자기소개로 시작해서 다시 같은 페이지로 마무리하는 구성이 좋았습니다. 전달하고자 하는 메시지도 분명했구요. 물론 모두에게 도움이 되는 조언은 아니겠지만, 하나의 길만 있는 것은 아니라는 교훈 같네요. 1. 비전통적 경력의 힘 발표자는 컴퓨터공학을 전공하고 소프트웨어 엔지니어로 커리어를 시작했으나, 대학 시절 취미로 시작한 뜨개질이 점차 열정이 되어 니트웨어 디자인과 출판, 사업까지 확장하게 됨. 니트 패턴 작성 경험을 통해 논리적 구조화, 스타일가이드 제작, 명확한 커뮤니케이션 등 테크니컬 라이팅과 유사한 역량을 쌓음. (물론, 이건 어느 정도는 테크니컬 라이팅 직무에 지원하면서 만들어낸 논리가 아닌가 싶습니다. 니트 패턴 작성을 할 때 깨달은 건 아니라는 거죠. 다만 니트 패턴을 만드는 것..
WTD 포틀랜드 2025 - AI는 단순히 '문서를 대신 써주는' 도구가 아닙니다 1. AI 도구에 대한 현실적 시각 AI가 문서화 분야에 광범위하게 도입되고 있지만, 과도한 홍보와 회의론이 공존하는 혼란스러운 상황임을 지적합니다. 단순한 코드 변환, 정규식 생성 등 ‘작고 명확한’ 기술 작업에는 AI가 이미 유용하게 쓰이고 있으나, 여전히 ‘환각(hallucination)’ 문제 등 한계가 존재함을 강조합니다. 2. AI로 문서를 ‘작성’하는 것의 한계 AI를 단순히 문서 초안 작성이나 카피 에디팅에 쓰는 것은 기존의 스타일 린팅, 규칙 적용과 큰 차별점이 없다고 평가합니다. 오히려 테크니컬 라이터가 ‘즐기는 일’과 ‘자동화로 시간을 절약할 수 있는 일’을 구분해, AI는 반복적이고 비핵심적인 작업에 집중적으로 활용하는 것이 바람직하다고 조언합니다. 3. 진짜 혁신: RAG 기반 챗..
WTD 포틀랜드 2025 - Docs as Tests 이번 발표자 Manny Silva는 지난 4월 이번 발표와 같은 제목으로 책을 펴냈습니다. 아마 자세한 내용은 책을 보시면 나와 있을 것 같네요.Docs as Tests: A Strategy for Resilient Technical Documentationhttps://www.amazon.com/Docs-Tests-Resilient-Technical-Documentation-ebook/dp/B0F1H97QSL 1. 문제 인식: 문서와 제품의 불일치 제품 UI, API, 코드 등이 변경될 때 문서는 자주 뒤처져 사용자 혼란과 신뢰 저하, 지원 비용 증가, 심지어 법적 문제까지 발생할 수 있음. 전통적 문서 검증은 수동 테스트에 의존해 한계가 많음. 실제로는 사용자들이 문서를 사용하며 오류를 발견하는 경우..
반응형

티스토리툴바