본문 바로가기

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

(183)
WTD 포틀랜드 2025 - 지원팀과 함께 정성적인 피드백 확보하기 AWS에서 고객이 기술 지원을 받는 절차는 다른 곳과 크게 다르지 않습니다. 먼저 문서를 통해 하고자 하는 일을 어떻게 하는지 살펴보고 뭔가 막히는 부분이 있으면 기술 지원을 받고 심각한 문제가 생기면 요구사항을 등록합니다. 아래 그림에서 설명하는 내용이고 기술 문서 담당자는 이 중 첫 번째 단계(Self service)를 담당하게 됩니다. 문서팀이 가지고 있는 과제는 사용자가 뭔가 막히는 지점 때문에 지원 요청을 하는 케이스가 44%라고 합니다. 즉, 44%의 기능에 대한 문서화가 부족하거나 잘못되었다고 추측할 수 있습니다. 그리고 문제를 검토하면서 지원팀에서 문서를 참고하지 않았다고 합니다. 문서가 잘못된 상태라서 참조할 필요가 없다고 느꼈다는 것이죠. 이런 차이가 생기는 문제는 3가지로 정리할 수 ..
WTD 포틀랜드 2025 - 슈퍼 유저 그룹 중심으로 문서 피드백 활성화하기 기술 문서를 작성하면서 테크니컬 라이터가 사용자를 대변한다는 이야기를 많이 합니다. 하지만 많은 경우 테크니컬 라이터의 경험적인 느낌만으로 일을 진행하곤 합니다. 이런 느낌보다는 데이터를 기반으로 사용자가 어떤 것을 필요로 하는지 알아야 합니다. 그래서 사용자 피드백이 중요합니다. 하지만 모든 사용자 피드백이 다 도움이 되는 건 아닙니다. 뉴스에 달리는 댓글처럼 아무 생각 없는 비판적인 댓글도 상당히 많습니다. 도움이 되는 피드백은 아래와 같은 것들입니다. - 제품과 관련이 있는 피드백 - 문제를 확인하고 개선할 수 있는 피드백 - 문서의 품질을 향상시킬 수 있는 피드백 - 제품의 품질을 향상시킬 수 있는 피드백 - 조직의 역량을 향상시킬 수 있는 피드백 사용자 피드백을 얻기 위해 어떤 시도를 해보았나요..
WTD 호주 2025(Virtual) - AI 도구를 사용해 릴리스 노트 자동으로 생성하기 호주 오프라인 컨퍼런스는 가을 정도에 개최를 하는데 Virtual 이벤트라고 영상이 올라왔더라구요. 찾아보니, 이전에도 간혹 진행했던 행사인 모양입니다. 이번에는 idratherbewriting.com 블로그 운영자로 잘 알려진 Tom Johnson의 발표입니다. 블로그를 구독하거나 간혹 보시는 분들은 최근 AI 관련해서 올라오는 그의 글을 이미 보았을 겁니다. 참고발표 슬라이드와 원본 블로그, 관련 영상을 참고할 수 있습니다.슬라이드 https://idbwrtng.com/releasenoteswithai(블로그) Using file diffs for better release notes in reference docs https://idratherbewriting.com/ai/prompt-enginee..
WTD 호주 2024 - 라이트닝 토크 모음 Michael Park - Interviewing tips and tricks Canonical은 원격 근무를 기본으로 하고 있어서 전 세계적으로 채용을 진행합니다. 때문에 채용 프로세스가 상당히 엄격하다고 하네요. (면접 후기가 궁금하신 분들은 아래 링크를 참고하세요). Canonical 채용 면접 후기 https://brunch.co.kr/@youngstone89/309아마 직군에 따라 인터뷰에서 중요하게 여기는 부분이 다를텐데 Michael Park는 5W1H(Who, What, Where, When, Why, How)를 중심으로 인터뷰를 진행하고 그중에서도 Why와 How에 초점을 맞춘다고 합니다. - Why are you a technical writer - Why do you want to b..
WTD 호주 2024 - AI로 만든 짧은 동영상으로 정보 제공하기 기존에 만들었던 영상은 1시간 분량인데, 통계를 보면 30분 이후에 50% 이상 이탈하는 것을 확인할 수 있습니다. 기대했던 것보다 낮은 수치라 70% 이상 참여할 수 있게 하고 싶었습니다. 1분 내외의 영상을 만들고 나서 85% 이상이 필요한 영상을 찾아서 확인하고 있다고 합니다. 실제 영상 목록을 보면 1분에서 6분 정도로 구성하고 있습니다. 명확하게 영상의 요약을 제시하고 사용자가 필요한 영상만 선택해서 볼 수 있게 합니다. 때문에 1시간짜리 영상을 보는 것과는 결과가 명확히 달라지겠죠. https://knowledge.eptura.com/Asset/Training_Videos영상을 만들 때 AI 도구(synthesia)를 사용해 각 제품별로 아바타를 따로 생성합니다. 그렇게 하면 사용자는 자신이 ..
WTD 호주 2024 - 문서 리뷰는 어떻게 하나요? - 효과적인 검토 전략:  좋은 문서와 효과적인 리뷰는 함께 진행되어야 합니다.  문서 작성자가 문서 작성을 쉽게 시작할 수 있도록 모범 사례와 구조화된 프레임워크를 지원합니다. 리뷰는 문서 작성자의 기술 수준이나 문서화 프로세스에 대한 이해도에 따라 맞춤형 피드백을 제공해야 합니다. - 엔지니어의 글쓰기 장려 엔지니어는 기술적 정확성을 기반으로 탄탄한 문서를 작성할 수 있습니다.  구조화된 템플릿과 지침을 제공하고, 테크니컬 라이터가 콘텐츠를 다듬고 개선하면 엔지니어가 효과적으로 문서화에 기여할 수 있습니다. - 문서의 유형 및 작성자의 역할:  엔지니어는 빠르게 바뀌는 세부적인 문서(예: 참조 문서)를 작성하는 데 탁월합니다. 테크니컬 라이터는 명확성, 스토리텔링, 콘텐츠 구조화(예: 설명서)에 중점..
WTD 호주 2024 - 문서 사용자 피드백을 통합하고 인사이트 얻기 Austin Lai의 이전 직장은 DataDog이었습니다. 모니터링, 보안 통합 솔루션을 제공하는 곳이라 조직 내 솔루션을 이용해 문서 사용자 피드백을 분석할 수 있었다고 합니다. 그리고 외부 솔루션으로 hotjar를 사용했습니다. hotjar에서 사용자 설문을 처리하는 기능을 사용했는데, 문서마다 특성에 맞는 피드백을 받을 수 있도록 설계했다고 합니다(이 부분은 제가 잘못 이해한 것일수도 있겠네요. 실제 문서 사이트에 반영된 내용과는 좀 다른 것 같습니다). 슬랙 채널을 사용해 내부, 외부 사용자의 피드백을 받았습니다. 그리고 Metabase를 사용해 데이터를 분석합니다.번역은 transifex를 사용하는데, 번역자가 오타 등을 발견했을때 이를 이슈로 등록할 수 있는 채널이 열려있다고 합니다(정확하지는..
WTD 호주 2024 - 다른 분야에서 기술 문서를 위한 인사이트 얻기 저널리즘, 광고 카피를 만드는 기술을 테크니컬 라이팅에서 어떻게 활용할 것인지 안내합니다. 대부분 내용은 테크니컬 라이팅 교과서에서도 언급하고 있는 이야기라서 딱히 새롭다고 할 수는 없습니다. 콘텐츠를 검토하는 과정에서 운율이 맞는지 확인해 보라고 하는 이야기도 일반적인 글쓰기에서 실제 소리 내어 읽어보라는 지침에서 크게 벗어나지 않습니다. 다만, 이 부분이 인상적이었는지 Q&A에서 꽤 많은 시간 이야기가 되었습니다. 청중 중에 추가적인 조언으로 그냥 읽는 것이 아니라 리듬을 맞추어 읽어보라는 조언도 있었습니다. 한국어에도 맞는지는 모르겠지만 예를 들어 배경음악(메트로놈 같은)을 틀어놓고 읽으면 좀 더 리듬에 집중에서 콘텐츠를 검토할 수 있다고 합니다. 발표 내용 중에 저널리즘, 사설, 광고, 기술 문서..

반응형