분류 전체보기
-
TCN Meetup 10월 요약Technical Writing 2023. 12. 12. 21:20
지난 2월에 이어 10월에 TCN 카페에서 Meetup을 진행했습니다. 이번에도 야근..으로 인해 실시간으로 참석은 못했지만 아래 다시보기 링크에서 영상을 볼 수 있습니다. https://www.youtube.com/watch?v=6isqg2197Ic&list=PLf0uesSmd9rLzEZc6Szc7-kOW4EDu1UQA 이번 세션은 총 3가지로 1) 한 셋트의 매뉴얼이 만들어지기까지, 2) 업무적 글쓰기가 고민인 당신을 위하여, 3) Technical writing 기본과 원칙 이라는 주제로 진행되었습니다. 이번 Meetup은 내가 관심있는 주제가 나와서 집가서 다시보기로라도 꼭 들어봐야겠다고 결심했죠! 개인적으로 1번 세션이 가장 관심있는 주제였습니다. 이전에 진행했던 라인이나 우아한 형제들 글쓰기 ..
-
TCN Meetup 2월 밋업 요약Technical Writing 2023. 2. 26. 12:24
TCN Meetup이 2/15일에 진행되었습니다. 일정 때문에 아쉽게도 실시간으로 참석하지는 못했지만 아래 링크에서 다시 보기를 제공하기 때문에 밋업 영상을 보고 요약하는 포스팅을 작성해보려고 합니다. https://www.youtube.com/@tcnkorea Technical Communicator Network Technical Communicator Network Community www.youtube.com 들어가며 이전 포스팅에서도 잠깐 언급한 적이 있지만 TCN 카페는 테크니컬 커뮤니케이터들을 위한 커뮤니티 카페입니다. 가입 인원은 꾸준히 늘고 있고 채용 공고도 지속적으로 업데이트되고 있지만 정보를 얻기 위한 글이나 교류는 사실 많지 않았습니다. 그렇기 때문에 이번 TCN Meetup이 더 ..
-
테크니컬 라이터를 위한 6가지 새해 결심과 목표사담 2023. 2. 12. 15:44
이 포스팅은 '7 New Year's Resolutions for Technical Wrtiers'(원문링크)의 포스팅을 번역하고 나는 이제까지 어떻게 공부해 왔는지 되돌아보고 올해 목표 설정 해보려고 한다. 원문 링크의 목표는 2023년에 시도해야 할 7가지 테크니컬라이팅 목표와 역량을 향상하기 위해 염두해야 할 사항을 설명하고자 한다. 이 글은 2022년 12월에 올라온 글이고 1월부터 이 글을 토대로 목표를 세워야지!라고 결심을 했지만 이런저런 일로 이제야 포스팅을 마무리한다.(임시저장한 글만 몇 개인지 모르겠다😂) 1. 테크니컬 라이터 컨퍼런스 참여하기 컨퍼런스 및 기타 업계 이벤트를 통해 테크니컬라이터로 성장을 촉진하고 업계 사람들과 연결될 수 있다. 테크니컬 라이팅이라는 주제만으로는 컨퍼런스를..
-
[라인개발실록] 라인 테크니컬라이터가 하는일/전망/오해와 진실 요약Technical Writing/Technical Writer 2022. 12. 11. 17:13
(사담) 2주일에 최소 한번은 포스팅을 하자고 다짐했는데 요새 너무 정신도 없고 출퇴근에 체력을 소모해버려서 정말 오랜만에 포스팅을 한다😥 예전부터 이 동영상도 보고 꼭 정리해야지 라고 결심했는데 벌써 1개월 전 영상이다. 우아한 형제들에서 진행한 [우아한 테크 세미나]에서도 테크니컬라이터에 대해 다루어서 정리했었는데, 이번에는 라인에서 진행하는 [라인 개발 실록]에 테크니컬라이터를 다룬다고 하니 안 볼 수가 없었다. 영상은 아래 링크에서 볼 수 있고 3개의 테마로 나눠서 업로드되었다. https://www.youtube.com/watch?v=95E0EbHo2xQ Session 1: LINE에서 테크니컬 라이터가 하는 일 먼저 이인실 테크니컬 라이터님께서 테크니컬라이터 일을 하게 된 계기에 대해서 간략하..
-
나도 모르게 자주 쓰는 번역투를 알아보자사담 2022. 8. 17. 22:03
먼저 번역투란 외국어를 우리말로 번역하면서 생긴 표현입니다. 한글로 쓰였지만 묘하게 이해가 되지 않거나 어딘가 문장이 이상하네 라는 느낌이 들기도 합니다. 하지만 요즘에는 번역투가 이미 널리 쓰이고 있기 때문에 이상한 점을 모르고 나도 모르게 자주 쓰이기도 합니다. 그래서 오늘은 나도 모르게 자주 쓰고 있는 번역투를 정리해보려고 합니다. 저 조차도 이미 머리로는 알고 있지만 손은 나도 모르게 번역투를 쓰고 있는 경우가 많더군요😯 아마 이 포스팅에서도 나도 모르게 쓰고 있는 번역투가 몇 개 발견되지 않을까 싶습니다. 번역투 무조건 틀린 표현일까? 본론으로 들어가기 앞서 그럼 '번역투를 사용하면 어법에 맞지 않는 걸까?'라고 생각한다면 그건 아닙니다. 국립국어원에서는 번역투 표현을 쓰는 것이 어법적으로 '틀..
-
[우아한 테크 세미나] "개발자도 글을 잘 써야 한다고요?" 테크 세미나 요약과 느낀점Technical Writing/Technical Writer 2022. 7. 29. 19:00
아직까지는 국내에 테크니컬 라이팅에 대한 인지도나 강의 등이 외국에 비해서 덜하다고 생각했습니다. 하지만 최근에 한겨레 교육센터에서도 테크니컬 라이팅 교육을 진행하고 채용 공고도 2-3년 전에 비해서 많이 증가했다고 느끼고는 합니다. 직무 관련해서 아직 궁금한 게 너무 많은데 국내에서는 강의를 많이 진행하지도 않고 아쉬워서 구글 테크니컬 라이팅 관련 세션에 참여를 했었던 적이 있었습니다. 하지만 영어 진행 + 시차로 인해서 새벽에 진행돼 다소 힘들었던 기억이 납니다... 오늘도 여기저기 글들을 읽어보던 중 배민에서 '개발자도 글을 잘 써야 한다고요?'라는 라이브를 진행한다는 것을 알게 되었습니다. 얼마 전 배민에서 테크니컬 라이팅 코치를 채용하는 공고를 본 적이 있는데 개발자를 위한 글쓰기 등의 책을 쓰..
-
API 문서화 공부하기 - 8 깃북과 마크다운으로 API 문서 정리하기API 2022. 7. 11. 20:41
1 - 7 포스팅을 통해 API에 대해서 공부해보았다. 공부한 내용을 바탕으로 작성한 Surfreport 예시를 이미 익숙한 툴인 깃북과 마크다운 문법으로 정리해보려고 한다. API가이드를 작성할 때 자주 사용되는 툴로는 Swagger와 앞서 잠깐 살펴보았던 Postman도 있다. 아직 본격적으로 사용해보지는 않았지만 API에 대해서 공부하면서 언젠가 사용해볼 기회가 있지 않을까?_? gitbook 먼저 깃북에서는 API를 작성할 수 있는 블록을 제공한다. API Method를 클릭하면 아래와 같은 블록이 생성된다. 이 블록에 입력 값을 입력만 해주면 이제까지 봤던 API문서의 형태로 정리할 수 있다. 요새 깃북을 사용해보고 있어서 깃북을 통해 정리해보려고 했다. 하지만 깃북을 사용하다 보니 다른 툴을 ..
-
API 문서화 공부하기 7 - 응답 예제와 응답 스키마API 2022. 6. 30. 22:49
이사 준비로 어영부영 6월이 지나갔다. 이사를 무사히 마쳤으니 다시 열심히 포스팅해야겠다! 😁 응답 예제와 응답 스키마 응답 예제는 요청 예제의 샘플 응답을 보여준다. 응답 예제는 모든 매개변수를 포괄하지는 않지만 요청 예제에서 전달된 매개변수와 일치해야 한다. 응답을 통해 개발자는 리소스에 원하는 정보, 형식 및 해당 정보가 구조화되고 레이블이 지정되는 방식이 무엇인지 알 수 있다. 응답에 대한 설명을 응답 스키마라고 한다. 응답 스키마는 반환될 수 있는 각 속성, 각 속성에 포함된 내용, 값의 데이터 형식, 구조 및 기타 세부 정보를 나열하여 보다 포괄적인 방식으로 응답을 문서화한다. 응답 스키마 살펴보기 응답 예제와 응답 스키마의 차이는 무엇일까? 응답 예제는 요청 예제와 일치해야 한다. 요청 예제..