본문 바로가기

분류 전체보기

 (2683)
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가지로 정리할 수 ..
[리뷰] The Product is Docs Splunk 문서팀의 경험을 공유한 책입니다. 뭔가 당장 실무에 도움이 될 만한 책인가 싶었지만, 살짝 개념적인 이야기가 너무 많긴 합니다. 2017년에 나온 책이라 일부 이야기는 요즘 프로세스에는 맞지 않을 수도 있습니다.https://www.amazon.com/Product-Docs-technical-documentation-development-ebook/dp/B085KHTV95 혹시, 이 책이 궁금하신 분들을 위해 각 챕터 내용을 살짝 요약해보았습니다(책을 다 읽긴 했지만 너무 오래 전 일이고, 직접 요약하기는 귀찮아서 요약은 AI가 ㅠㅠ). 1. IntroductionSplunk 문서팀의 경험을 바탕으로, 기술 문서 작성의 실무적·현실적 관점을 제공한다.기존의 이론 중심 자료나 UX/마케팅 중심..
헤르만 헤세의 『전쟁과 평화』 민음사 판 '싯다르타'를 읽고 맨 뒤에 연표를 보는데 1946년에 '전쟁과 평화'라는 작품명이 보였습니다. 음. 이건 그 러시아 톨스토이가 쓴 책 아닌가 싶어 찾아보았는데 헤르만 헤세의 '전쟁과 평화'라는 번역서는 없더라구요.위키피디아 한국어 버전에는 없는데 나무위키에는 있었습니다. 음. 이거 어디선가 오타를 난 것을 옮기면서 발생한 문제 아닌가 싶었습니다. 하지만 독일어 위키피디아에는 'Krieg und Frieden'라는 작품이 있습니다. "1914년 이후 전쟁과 정치에 대한 성찰"이라는 설명과 함께 실려 있는 걸 보면 소설보다는 에세이 형식이 아닌가 싶습니다. 국내에는 '전쟁과 평화'라는 제목으로 번역된 책은 없고 '헤세로부터의 편지'라는 제목으로 황금가지에서 2003년 펴낸 책에 '전쟁과 평화..
[리뷰] Technical Writing for Software Developers 2024년 봄에 출간된 책입니다. 저자인 Chris Chinchilla는 개발자는 아니라서 실질적인 개발 프로세스를 다루지는 않습니다. 최근 나오는 테크니컬 라이팅 관련 서적이 대부분 개발자를 대상으로 하고 있는데, 아무래도 대상 독자의 수가 개발자가 더 많다고 생각해서 그렇겠죠. 하지만 생각보다 책이 잘 나가는 것은 아닙니다.https://www.amazon.com/Technical-Writing-Software-Developers-communication-ebook/dp/B0CYL9SWZ5/ 혹시, 이 책이 궁금하신 분들을 위해 각 챕터 내용을 살짝 요약해보았습니다(책을 다 읽긴 했지만 직접 요약하기는 귀찮아서 요약은 AI가 ㅠㅠ). 1장 The Why, Who, and How of Tech Wri..
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에서 테크니컬 라이터 ..
반응형

티스토리툴바