본문 바로가기

테크니컬 라이팅

 (433)
WTD 포틀랜드 2025 - 언젠가는 문제가 될 수 있습니다 발표자가 현재 직장(이전 직장은 MongoDB)으로 2020년 옮긴 후 문서 상황은 이러했습니다. 모든 문서는 엔지니어가 작성한 문서였고(테크니컬 라이터가 없는 상황이라서) 문서 배포는 루비로 직접 구현한 도구를 사용하고 있었습니다. 해당 도구를 처음 개발한 개발자는 너무 바빠서 유지보수를 할 수 없었고 사내에 루비를 아는 다른 엔지니어는 없었습니다. MinIO(현재 직장)에서 다루는 제품은 상당히 복잡합니다. 이 말은 다양한 그룹의 사용자를 가지고 있다는 이야기이고, 하나의 문서로 모든 사용자 요구를 만족시키기 어렵다는 것입니다. 작은 규모의 스타트업에서 자체 개발한 문서 도구를 사용하는 것은 무리라고 판단해서 스핑크스(Sphinx)로 전환하기로 했습니다. 이전 직장(MongoDB)에서 사용하던 도구라..
WTD 포틀랜드 2025 - 테크니컬 라이터를 위한 7가지 작은 습관 영문학을 전공하고 우연한 기회에 3년 후 테크니컬 라이터 일자리를 얻게 되었습니다. 그 당시에는 HTML이 뭔지도 모르는 시절이었죠. 그리고 10년이 지나 Datadog에 시니어 테크니컬 라이터로 옮길 수 있었는데, Datadog의 코딩 테스트를 통과했습니다. 이걸 아는 분들이 7년 사이에 무슨 일이 있었던 거야라고 물어보는데 적절한 답이 생각나지 않아 이번 세션을 준비했다고 합니다. WTD 컨퍼런스를 계속 보신 분이라면 얼굴이 익숙할 텐데 2021년부터 컨퍼런스 스태프로 참여해서 Q&A 시간에 자주 봐서 그럴 겁니다. 누군가 "테크니컬"하게 만드는 여러 가지 요인들이 있는데, 발표자의 생각으로는 습관이 중요하다고 합니다. 작은 습관들이 쌓여서 "테크니컬"하게 만드는 것이랍니다. 아마도 제임스 클리어의 ..
WTD 포틀랜드 2025 - 혼란 가운데 일하는 테크니컬 라이터들에게 발표 제목처럼 발표 내용도 약간 혼란스러웠습니다. 중간에 경품을 뿌리면서 답변을 받고, 발표 내용도 딱 정리가 되지 않아 어떻하지 싶어 그냥 이번 발표는 AI에게 정리를 요청해보았습니다. 그런데 정리된 내용을 보니 꽤 체계적인 발표였네요. 결국 제가 문제였나 봅니다. Stephanie Fuller(25년 경력의 시니어 테크니컬 라이터)가 발표한 "Writing the Shipwreck" 세션입니다. 발표자는 기술 문서화 환경이 매우 혼란스럽고 낡은 상태(‘난파선’)에서 어떻게 체계적으로 문제를 진단하고, 개선 계획을 수립하며, 실제로 문서 시스템을 성공적으로 전환했는지 자신의 경험을 바탕으로 설명합니다. 1. 문제 상황 진단(Shipwreck) 발표자가 처음 맡은 문서 환경은 낡은 도구(Gitbook ..
2025년 6월 테크니컬 라이팅 이런 저런 소식 6월 4일NHN Cloud 빠른 시작 가이드를 소개합니다https://meetup.nhncloud.com/posts/392...빠른 시작 가이드와 튜토리얼이 같은 목적을 가진 문서로 보일 수 있지만 사실 두 문서는 서로 다른 목적을 가집니다. 두 문서 모두 어떤 기능을 사용하거나 작업을 완료하는 방법을 다루는 문서이지만 튜토리얼은 앞서 설명한 빠른 시작 가이드의 특징과 다르게 사용자가 더 넓고 복잡한 작업을 수행할 수 있도록 돕습니다. 따라서 타깃 대상도 처음 서비스를 사용하는 사용자가 아닌 심화 학습을 원하는 사용자이며 빠른 시작 가이드 대비 내용이 더 길고 복잡한 작업을 다룹니다...https://docs.nhncloud.com/ko/quickstarts/ko/overview/ NHN 클라우드의 빠른..
WTD 포틀랜드 2025 - 규제가 문서화에 미치는 영향 반도체나 의료 기기 등 몇몇 산업군에서는 상당히 많은 테크니컬 라이터가 일하고 있음에도 어떤 일을 하는지 잘 알려져 있지 않습니다. 소프트웨어 같은 경우에는 테크니컬 라이터가 아니라도 기술 문서를 작성하고 블로그 등에 게시할 수 있습니다. 하지만 일부 산업군은 공식적인 문서가 아니면 접하기가 어렵습니다. 그 이유가 바로 규제 때문이죠. 그냥 막 맘대로 글을 쓰면 문제가 될 수 있다는 겁니다. 이번 발표는 그런 배경을 가지고 있는데, 발표 내용은 좀 뒤죽박죽이라 딱 뭔가 정해진 주제가 애매하긴 합니다. 그냥 이런 산업군에서 이런 어려움도 있다 정도로 보면 될 것 같네요. Brainlab은 독일 뮌헨 기반의 의료기기 업체입니다. 6명의 테크니컬 라이터가 있구요. 다른 기술 분야와 다르게 출신이 좀 색다릅니다..
WTD 포틀랜드 2025 - 지원팀과 함께 정성적인 피드백 확보하기 AWS에서 고객이 기술 지원을 받는 절차는 다른 곳과 크게 다르지 않습니다. 먼저 문서를 통해 하고자 하는 일을 어떻게 하는지 살펴보고 뭔가 막히는 부분이 있으면 기술 지원을 받고 심각한 문제가 생기면 요구사항을 등록합니다. 아래 그림에서 설명하는 내용이고 기술 문서 담당자는 이 중 첫 번째 단계(Self service)를 담당하게 됩니다. 문서팀이 가지고 있는 과제는 사용자가 뭔가 막히는 지점 때문에 지원 요청을 하는 케이스가 44%라고 합니다. 즉, 44%의 기능에 대한 문서화가 부족하거나 잘못되었다고 추측할 수 있습니다. 그리고 문제를 검토하면서 지원팀에서 문서를 참고하지 않았다고 합니다. 문서가 잘못된 상태라서 참조할 필요가 없다고 느꼈다는 것이죠. 이런 차이가 생기는 문제는 3가지로 정리할 수 ..
WTD 포틀랜드 2025 - 슈퍼 유저 그룹 중심으로 문서 피드백 활성화하기 기술 문서를 작성하면서 테크니컬 라이터가 사용자를 대변한다는 이야기를 많이 합니다. 하지만 많은 경우 테크니컬 라이터의 경험적인 느낌만으로 일을 진행하곤 합니다. 이런 느낌보다는 데이터를 기반으로 사용자가 어떤 것을 필요로 하는지 알아야 합니다. 그래서 사용자 피드백이 중요합니다. 하지만 모든 사용자 피드백이 다 도움이 되는 건 아닙니다. 뉴스에 달리는 댓글처럼 아무 생각 없는 비판적인 댓글도 상당히 많습니다. 도움이 되는 피드백은 아래와 같은 것들입니다. - 제품과 관련이 있는 피드백 - 문제를 확인하고 개선할 수 있는 피드백 - 문서의 품질을 향상시킬 수 있는 피드백 - 제품의 품질을 향상시킬 수 있는 피드백 - 조직의 역량을 향상시킬 수 있는 피드백 사용자 피드백을 얻기 위해 어떤 시도를 해보았나요..
2025년 5월 테크니컬 라이팅 이런 저런 소식 5월 8일Write the Docs Portland 2025 행사가 잘 마무리되었나 봅니다. 현장 분위기를 살짝 느낄 수 있는 사진 앨범이 공유되었습니다. 아마 5월 말 정도에 발표 영상도 공유될 것 같네요.https://www.flickr.com/photos/writethedocs/albums/72177720325861452 10월에는 베를린, 11월에는 오스트레일리아 컨퍼런스가 준비되고 있습니다.https://www.writethedocs.org/conf/berlin/2025/news/welcome/https://www.writethedocs.org/conf/australia/2025/news/welcome/ 5월 9일State of Docs Report 2025 GitBook에서 테크니컬 라이터 ..
반응형

티스토리툴바