테크니컬 라이팅/WTD 컨퍼런스 (129) 썸네일형 리스트형 WTD 포틀랜드 2024 - 엔지니어링 원칙을 테크니컬 라이팅에 적용하기 컴퓨팅에서 블랙박스는 내부에서 어떤 일이 벌어지는지 몰라도 어떤 것을 입력했을 때 원하는 것을 출력할 수 있게 합니다. 하지만 엔지니어는 블랙박스에서 어떤 일이 벌어지는지 명확하게 알아야 합니다. 그리고 블랙박스에서 무슨 일이 일어나고 있는지 투명하게 설명하는 것은 테크니컬 라이터의 역할입니다.테크니컬 라이터가 블랙박스에 대해 설명하기 위해서는 많은 것을 알아야 하는데 이런 정보를 특정 엔지니어에게서 한 번에 얻는 것은 쉽지 않습니다. 대부분 조직에서 엔지니어는 자신이 담당하고 있는 일부 부분에 대한 정보만 제공할 수 있기 때문이죠. 그리고 블랙박스가 하나만 있는 것이 아니라 여러 개로 나누어져 있을 수도 있습니다. 참고: 101 things I learned in engineering school(번역.. WTD 포틀랜드 2024 - 인터랙티브한 콘텐츠 만들기 이 분은 커리어가 독특하네요. 미국과 중국, 일본에서 대학을 다녔습니다. 2008년부터 직장을 다니기 시작했는데 처음 시작한 일은 마케팅 쪽이었고 2017년에 5개월 정도의 부트캠프 과정을 거쳐 개발자로 전업을 합니다(주로 Developer Advocate 쪽 일을 했네요. 코딩을 배워서 IT 업계로 옮겼다는 것이 좀 더 정확한 표현일 것 같습니다. 하지만 중간중간 실제 개발 조직에서 일하기도 했다고 합니다). 전반부 내용은 일반적인 조언입니다. 딱히 특별한 내용은 없네요. 코드 블럭 작성 시 터미널 기호를 넣지 말라는 조언은 맘에 와닿긴 합니다. 실제로 저런 문서의 경우 복사해서 쓰고 싶은데 터미널 기호 때문에 다시 손을 대야 하거든요. 보기 좋게 하려고 줄 바꿈을 하는 명령어도 마찬가지입니다. 복사.. WTD 포틀랜드 2024 - 이미지를 적절하게 사용하기 기존의 문서는 사용자가 어디서부터 시작을 해야 하는지 이게 무슨 기술을 설명하는지 명확하게 알 수가 없었습니다. 그래서 데니스는 팀에 합류한 후 기존 문서 읽기를 포기하고 직접 기술을 다루면서 개발자들과 이야기하기 시작했습니다. 그리고 자신이 이해한 내용을 일러스트를 포함한 내용으로 작성했습니다. 데니스는 2023년에 WTD 컨퍼런스에 참여해 배운 몇몇 개념들을 실제 문서화에 반영했다고 합니다. 일러스트도 그중 하나이구요. 발표를 듣고 영감을 얻은 내용은 발표자와 좀 더 깊은 이야기를 나누었습니다. 그리고 그 결과물을 문서화에 반영한 것이죠. 튜토리얼 샘플에 대해서는 뭐 길게 이야기했지만 샘플을 제공할 때 UI와 비즈니스 로직 부분을 분리하는 것이 좋다는 것입니다. 그렇게 하면 디자이너나 개발자 모두 자.. WTD 호주 2023 - 라이트닝 토크 모음 Lightning Talk: Alec Clews - One Word Trick to Automate docs as code 보통 클라우드에서 작업할 때는 뭔가 피드백이 늦게 발생합니다(작업 환경에 따라 다르지만). 그래서 Git 클라이언트에서 사용할 수 있는 Git Hook 옵션을 제안합니다. 발표자료: https://docs.google.com/presentation/d/e/2PACX-1vSE_oFHfPPC8SuP0Nqvco6om2kLCX7DUDkKC_pqHdfcY7He7n5IBLPbZmj1yOlzDIJa9a_m6uAruRa1/pub?slide=id.p 데모: https://gitlab.com/alecthegeek/docs-as-code https://youtu.be/K-T0u-nIaOc?si=-JTc.. WTD 호주 2023 - 요즘 업계는 어떤가요? 이전에는 발표자 2-3명이 Q&A를 하는 형식이었는데 이번에는 Q&A는 각각 진행하고 패널 토의 형식의 새로운 세션이 만들어졌습니다. 2명은 발표를 하신 분이고 1명은 게스트로 초대를 했다고 하네요. 제목처럼 "Tech comms today" 업계 동향을 이야기하는 세션이었는데 어쩌다 보니 그냥 일반적인 이야기로 흘러간 것 같습니다. * 요즘 업계는 어떤가요? 궁금하다면 래딧을 참고하세요. 주로 북미 쪽 이야기가 많긴 하지만 최근 업계가 어떤지 참고할 수 있습니다. 주로 나쁜(?) 이야기가 많은데 좋은 이야기는 보통 이런 커뮤니티에서 하지 않아서 ^^ 불만 그런 것이 많습니다. https://www.reddit.com/r/technicalwriting/ Sarah Maddox 2024.01.23 - [테.. WTD 호주 2023 - 거절에 대처하는 방법 바다 건너 일하는 친구들은 해고에 대해서 그렇게 심각하게 받아들이지 않는다고 이야기하지만(한국에 비해서) 꼭 그런 것은 아닌가 봅니다. 어찌 되었든 해고라는 것은 거절의 다른 표현이기 때문에 누구나 맘이 편한 것은 아닙니다. 발표자 또는 그들의 지인이 겪은 인터뷰, 채용, 해고 등에 대한 이야기를 전달합니다. 그중 흥미로운 에피소드는 테크니컬 라이터 정규직으로 지원했는데 작문 능력이 떨어진다고 피드백을 받으면서 거절당했습니다. 하지만 얼마 후 같은 회사에 계약직으로 일하게 되었고 작문 능력이 뛰어나다며 정규직 제안을 받았다고 합니다. ATS에 대한 이야기도 흥미롭네요. 아마 규모가 어느 정도 있는 회사의 이야기겠지만 적절한 키워드가 포함되어야 하고 기회가 된다면 이력서를 수정해서 다시 지원해야 합니다. .. WTD 호주 2023 - 스타트업에서는 모든 것을 다 해볼 수 있을까? 이전에는 주로 규모가 있는 기업에서 계약직 또는 정규직으로 일하다가 스타트업에서 일할 기회가 생겨서 합류했다고 합니다. 스타트업에서는 이전에 하고 싶었지만 하지 못했던 이런저런 일들을 좀 더 자유롭게 할 수 있을 것이라 기대했습니다. 하지만 예산 문제, 의사 결정의 책임 문제 등으로 인한 현실에 맞닿게 됐습니다. 다른 세션에 비해 짧은 시간 진행했지만 분위기도 좋고 Q&A 세션도 반응이 좋네요. 다만 하고자 하는 이야기가 어떤 것인지 포인트는 잘 잡지 못하겠네요 ㅠㅠ 파이에 대한 비유는 humble pie 라는 표현으로 겸손하게 행동하다는 의미라고 합니다. 스타트업에서는 내가 중요한 결정을 내리는 경우가 많은데 항상 최선의 결정을 내릴 수는 없다는 것입니다. 그래서 이를 인정하고 겸손한 마음을 가져야 한.. WTD 호주 2023 - 박물관에도 테크니컬 라이터가 있나요? 독특하게 박물관에서 일하는 테크니컬 라이터라고 합니다. 한국에서는 제조 또는 IT 분야에서만 테크니컬 라이터를 생각하는데 다양한 분야에서 테크니컬 라이터가 일하고 있는 것을 알 수 있습니다. 테크니컬 라이터가 되기 위한 경로가 그만큼 많은 것이죠. 박물관에서 테크니컬 라이터는 전시물을 분류하고 이에 대한 기록을 남기고 데이터를 관리하는 등의 일을 한다고 합니다. 그래서 하는 일은 일반적인 테크니컬 라이터가 하는 일과 크게 다르지 않습니다. 감사(Audit) - 작업 대상을 선별하고 우선순위를 정하세요. - 감사 도중에 바로 고칠 수도 있지만 작업은 나중에 하세요. 그렇지 않으면 감사 작업을 마치지 못할 겁니다. 컨트롤(Control) 이 부분은 3가지를 왜 비교해서 설명하는지 잘 이해가~ 뭐 하여간 어떤.. 이전 1 2 3 4 5 6 7 ··· 17 다음
