본문 바로가기
728x90

테크니컬 라이팅

 (353)
WTD 프라하 2021 - API 설계에 참여하기 Fabrizio Ferri Benedetti는 Splunk에서 테크니컬 라이터로 일하고 있습니다. 링크드인 프로필을 보면 테크니컬 라이터와 함께 API 디자이너라고 자신을 소개하고 있습니다. 이번 세션의 주제는 일반적으로 엔지니어의 영역이라고 생각하던 API 디자인을 테크니컬 라이터가 어떤 식으로 참여하고 주도할 수 있는지 그리고 왜 테크니컬 라이터가 API 디자인에 강점을 가지는지를 설명합니다. 이 분 프로필 옆에 스피커 아이콘이 있는데요. 처음 보는 거라 확인해보니 자신의 이름 발음을 녹음하고 이를 방문자가 들을 수 있도록 하는 것이라고 합니다. 흔히 사용하지 않은 이름이라면 발음을 어떻게 해야 하는지 애매할 수 있는데 꽤 유용한 기능이네요. 관련 설명을 보면 데스크탑에서는 편집 기능을 제공하지 않고..
WTD 프라하 2021 - 사과문 작성하기 Ryan Macklin는 구글 테크니컬 라이터입니다. 링크드인 프로필을 보면 테크니컬 라이터이면서 empathy advocate라고 설명하고 있는데요. 이번 주제는 후자에 관한 것입니다. https://empathyadvocacy.org/ 라는 사이트도 운영하고 있는데요. empathy advocacy라는 것이 우리말로는 적절한 표현을 찾기가 애매한데 비슷한 것을 찾아보면 "공감능력 전문가"(실제 이런 제목을 가진 과정이 운영되고 있긴 합니다)와 가까울 것 같습니다. 일단 세션의 목적은 뭔가 문제가 생겼을 때 이를 사용자에게 어떻게 전달하고 사용자가 행동하게 하도록 하는 것인가를 다루고 있습니다. 전반부에 뇌에 대해서 설명하고 뭔가 기술적인 내용보다는 좀 더 감성적인 영역을 다루고 있어서 쉽게 이해하기는..
WTD 프라하 2021 - 문서의 구조가 튼튼한지 살펴보기 Lana Brindley는 Timescale이라는 시계열 데이터 솔루션 기업의 테크니컬 라이터 겸 관리자입니다. Timescale이라고 해서 일정 관리 소프트웨어인가 싶었는데 잘못짚었네요. 세션 시작에 Bundjalung(한국어 표기는 분달롱) 이야기가 나옵니다. 올해는 호주 WTD 이벤트가 취소되어서 아마 그때 하려고 했던 이야기를 꺼낸 것이 아닌가 싶습니다. WTD 세션 중 해당 지역에서 나온 이들은 간혹 그 지역의 이슈나 하고 싶은 이야기를 하더라구요. 하여간 분달롱은 호주 원주민이라고 합니다. https://en.wikipedia.org/wiki/Bundjalung_people https://youtu.be/Gm-0IIvWLmE 세션 중간에 나온 표 중에 독자에 대한 정의가 인상적이었습니다. 보통..
WTD 프라하 2021 - 히치하이커를 위한 문서화 도구, 프로세스 가이드 Lukas Reussner는 2018년 대학을 졸업하고 Bosch.IO에서 테크니컬 라이터로 일하고 있습니다. 보쉬 자회사로 고객사의 IoT 프로젝트를 지원하는 조직이라고 합니다. 하드웨어 개발부터 비즈니스 모델 설계까지 다양한 분야의 서비스를 제공한다고 합니다. WTD 프라하 2021 첫 세션이었던 이번 발표는 간단한 개념부터 시작해서 QFD(Quality Function Deployment) 기반의 멋진 도구까지 공개해주고 있습니다. 세션 앞부분에서 요구사항의 분류나 문서 도구를 소개할 때까지만 해도 그냥 이렇게 소개만 하면 처음 문서화 작업을 시작하는 이들에게도 아니면 뭔가 현재 프로세스를 바꾸고자 하는 이들에게도 만족스럽지 못할 것 같았는데 QFD 이야기로 넘어가면서 시트에 간단한 체크를 통해 적..
API The Docs 2020 - 제품 관리자와 테크니컬 라이터는 어떻게 같이 일하는가 코로나 시국이라 보통 혼자서 발표하는데 이번 세션은 둘이서 진행을 합니다. 조명이나 배경을 보면 같은 공간은 아니고 각자의 집에서 하는 것 같구요. 그래서 다른 세션보다 살짝 시간이 더 길게 나왔습니다. Onfido는 사진 기반 신원 확인 서비스를 제공하는 기업입니다. Minh Nguyen은 제품 관리자이고 Ben Ahmady는 테크니컬 라이터입니다. Ben Ahmady는 올해 8월 Checkout.com이라는 곳으로 자리를 옮겼네요. 제품 관리자 관점과 테크니컬 라이터 사이의 프로세스에 대해서 설명하는 흔치 않은 세션이긴 합니다. https://pronovix.com/event/api-docs-virtual-2020/ben-ahmady-minh-nguyen Ben Ahmady & Minh Nguyen ..
API The Docs 2020 - 소프트웨어 기업이 자신의 이야기를 더 잘 전달하는 방법에 대해 Adam DuVander는 테크니컬 라이터는 아니지만 와이어드에서 프리랜서로 기사를 작성했고 ProgrammableWeb 에디터로도 활동했습니다. 2013년부터 DR(Developer Relation) 쪽 일을 하다가 지금은 EveryDeveloper라는 회사(본인 회사인듯 합니다)에서 컨설턴트로 활동하고 있습니다. 기술 쪽 컨설팅보다는 DR 전담팀이 없거나 시작하는 기업에 가이드를 제공하는 일을 하고 있는 듯 합니다. 그런 활동의 일환으로 API 문서화에도 관심을 가지고 여러 가이드를 제안하는 것이지요. 때문에 이번 세션에 뭐 특별한 이야기가 있는 건 아닙니다. 어떤 식으로 기업에서 개발자들과 정보를 공유하고 이런 정보를 생성하는데 자동화를 적용할 수 있을지 뭐 그런 이야기라고 할 수 있습니다. htt..
API The Docs 2020 - 문서 내 사용되는 코드 샘플 자동화 Patrick Hammond은 Adyen라는 페이먼트 관련 기업의 프로젝트 매니저입니다. 링크드인 사이트에 가보면 Doc Ops를 담당하고 있다고 본인을 설명하고 있습니다. 영상 중에서도 나오는 표현이긴 합니다. WTD 사이트에서도 https://www.writethedocs.org/guide/doc-ops/ 라는 페이지에서 설명하고 있긴 한데 본인 소개에 사용하는 건 처음 본 것 같습니다. Adyen 같은 경우에는 비슷하지만 조금씩 다른 작은 샘플 코드를 작성하는 것이 이슈였다고 합니다. 그리고 7개 언어를 지원하면서(아마 주석 등에) 실제 작성해야 하는 코드 샘플이 계속 늘어나게 되는 구조입니다. 그래서 코드 샘플을 분석해서 자동으로 언어별 코드 샘플을 생성해주는 프로세스를 개발했다고 합니다. 문서 ..
API The Docs 2020 - API와 개발자 경험 Lorna Mitchell은 통신 서비스를 제공하는 보네이지(Vonage)의 DR팀 담당자입니다. 좋은 API라도 문서가 없다면 개발자들이 이를 사용하는데 어려움을 겪는다는 이야기입니다. 좋은 API 문서 또는 환경을 만들기 위해 어떤 것이 필요한지 설명하고 있습니다. 개발자들이 문서나 기능을 살펴볼 때 모든 항목을 한 번에 보지는 않습니다. 발표자는 이런 모습을 식당에서 메뉴판을 보고 주문하는 것이 비유했는데요. 특별한 경우가 아니면 모든 메뉴를 주문하지는 않는 모습과 비슷하다고 합니다. 때문에 문서를 만들 때는 적절한 분류를 통해 개발자가 원하는 항목을 선택할 수 있도록 해야 합니다. 메뉴판에 기재된 문서(음식)은 부족함이 없어야 합니다(마치 식당에 갔는데 메뉴마다 너무 편차가 심한 경우에는 좋은 식..
반응형

티스토리툴바