Comedy and technical writing - Adrian Doonan
발표자는 2019년(아마 이전에는 PM)부터 테크니컬 라이터를 시작했고 즉흥연기(Improvisation/Improv)도 비슷한 시기에 시작했다고 합니다.
아마 스탠드업 코미디 비슷한 것을 하는 것 같은데 즉흥연기와 테크니컬 라이팅의 비슷한 부분에 대한 이야기입니다.
1. 너무 어렵게 고민하지 말고 쓰세요. 뭔가 떠오르면 그대로 쓰고 당장 떠오르지 않는 것을 고민하지 마세요.
2. (note에 대한 이야기였는데 어떤 의미인지 모르겠네요 ㅠㅠ)
3. 상대방의 이야기를 경청하세요. 즉흥연기에서는 상대방의 연기에 맞추어 주는 것이 중요한데, 테크니컬 라이터도 개발자나 누군가와 이야기할 때 그들의 이야기를 듣고 적절하게 반응해 주는 것이 중요합니다.
Annotations in the Docs - Sadhana Suresh
문서 내 툴팁 형태의 간략한 도움말을 의미합니다. 용어집을 대체하는 것은 아니고 사용자의 문서 읽기 흐름을 깨지 않고 용어에 대한 도움을 제공하고자 하는 방식이라고 합니다. 마크다운 내에서 처리하는 방식을 설명하긴 했는데, 그건 사이트마다 다를 것 같구요.
아래 링크에서 어떤 식으로 구현했는지 확인할 수 있습니다.
https://docs.ionos.com/cloud/network-services/cdn/overview
We, tech writers, make AI intelligent - Jorge Leal
발표자가 이야기한 사이트인데 문서 사이트의 메인 페이지가 검색창으로 시작한다는 것이 인상적이네요. 다만, 실제 검색창은 아니고 검색창처럼 보이는 이미지를 클릭하면 질의를 작성할 수 있는 페이지로 이동합니다.
https://docs.empathy.co/
Why tech writers make perfect detectives - Julia Fischer
"Cain's Jawbone" 이라는 책에 대해 이야기합니다. 한국어 번역서는 "카인의 턱뼈"라는 제목이네요.
한국어판은 텀블벅 펀딩으로 진행했는데, 정답을 찾는 이벤트를 같이 했는데, 정답자는 없었다고 합니다. 유럽에서 당첨자에게 1000유로를 상금으로 걸어서 한국어판은 150만 원(아마 당시 환율 기준일 것 같네요)을 상금으로 걸었다고 합니다. 출판사에서는 정답을 아는 걸까요?
https://tumblbug.com/cainsjawbone
하여간 이 책은 책을 그냥 읽는 것이 아니라 책을 한장 한장 뜯어내서 재구성하면서 범인을 찾는 책이라고 합니다. 그래서 테크니컬 라이터의 일도 이처럼 정보를 나누고 재구성하는 과정이라 비유적으로 소개한 것 같네요.
Audio recording is like docs-as-code just louder - Marco Spinello
발표자는 작은 밴드에서 음악을 하고 있는데 그 밴드는 드럼이 먼저 시작하고 그 위에 베이스와 기타가 음을 얹어가는 식으로 작업한다고 합니다. 테크니컬 라이터도 비슷하게 PM, 개발자가 먼저 일을 하면서 그 위에 문서를 얹어가는 방식이죠. 그 외에도 반주를 위한 톤을 맞추는 작업은 스타일 가이드에 따라 문서를 작성하는 것과 비슷하고, 뮤지션 간의 소통은 이해관계자와의 소통과 비슷합니다.
혹시라도 발표자의 밴드가 궁금하다면 아래 링크를 참고하세요.
https://spinello-band.bandcamp.com/album/be-style
https://youtu.be/H9UsRyvuONA?si=NGen6Olb0U_JGzsY
