Technical Writing
-
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이 더 ..
-
[라인개발실록] 라인 테크니컬라이터가 하는일/전망/오해와 진실 요약Technical Writing/Technical Writer 2022. 12. 11. 17:13
(사담) 2주일에 최소 한번은 포스팅을 하자고 다짐했는데 요새 너무 정신도 없고 출퇴근에 체력을 소모해버려서 정말 오랜만에 포스팅을 한다😥 예전부터 이 동영상도 보고 꼭 정리해야지 라고 결심했는데 벌써 1개월 전 영상이다. 우아한 형제들에서 진행한 [우아한 테크 세미나]에서도 테크니컬라이터에 대해 다루어서 정리했었는데, 이번에는 라인에서 진행하는 [라인 개발 실록]에 테크니컬라이터를 다룬다고 하니 안 볼 수가 없었다. 영상은 아래 링크에서 볼 수 있고 3개의 테마로 나눠서 업로드되었다. https://www.youtube.com/watch?v=95E0EbHo2xQ Session 1: LINE에서 테크니컬 라이터가 하는 일 먼저 이인실 테크니컬 라이터님께서 테크니컬라이터 일을 하게 된 계기에 대해서 간략하..
-
[우아한 테크 세미나] "개발자도 글을 잘 써야 한다고요?" 테크 세미나 요약과 느낀점Technical Writing/Technical Writer 2022. 7. 29. 19:00
아직까지는 국내에 테크니컬 라이팅에 대한 인지도나 강의 등이 외국에 비해서 덜하다고 생각했습니다. 하지만 최근에 한겨레 교육센터에서도 테크니컬 라이팅 교육을 진행하고 채용 공고도 2-3년 전에 비해서 많이 증가했다고 느끼고는 합니다. 직무 관련해서 아직 궁금한 게 너무 많은데 국내에서는 강의를 많이 진행하지도 않고 아쉬워서 구글 테크니컬 라이팅 관련 세션에 참여를 했었던 적이 있었습니다. 하지만 영어 진행 + 시차로 인해서 새벽에 진행돼 다소 힘들었던 기억이 납니다... 오늘도 여기저기 글들을 읽어보던 중 배민에서 '개발자도 글을 잘 써야 한다고요?'라는 라이브를 진행한다는 것을 알게 되었습니다. 얼마 전 배민에서 테크니컬 라이팅 코치를 채용하는 공고를 본 적이 있는데 개발자를 위한 글쓰기 등의 책을 쓰..
-
Technical Writing Two - 문서 구조화 하기 (2) 목차와 탐색Technical Writing 2022. 3. 19. 14:07
Google Technical Writing 과정 정리의 마지막 포스팅입니다. 문서의 구성이 좋다는 것은 기술 문서의 사용자가 필요한 내용을 빠르게 찾고 이해하기 쉽도록 각각 주제들이 논리적으로 연결된 것을 의미한다고 합니다. 이번 포스팅에서는 문서를 구조화할 때 목차를 어떻게 작성해야 하는지 탐색 기능을 왜 추가해야 하는지에 대해서 작성해보려고 합니다. 목차 목차는 기술문서의 필수 요소로써 독자에게 기술문서의 구성을 한눈에 보여주는 아주 중요한 역할을 합니다. 5장 이내의 짧은 문서라면 목차를 반드시 작성하지 않아도 되지만 매뉴얼과 같이 몇 백 페이지가 넘어가는 긴 문서는 목차를 작성해주어야 독자가 피요한 정보를 빠르게 찾을 수 있습니다. 매뉴얼 작성 시에 항상 생각해야 하는 것 중에 하나는 긴 매뉴얼..
-
Technical Writing One - 목록 올바르게 사용하기Technical Writing 2022. 2. 24. 20:30
기술문서에는 가독성을 높이기 위해 목록이 자주 사용됩니다. 이번 포스팅에서는 Google Technical Writing 과정을 참고하여 목록의 유형에 대해서 알아보려고 합니다. 목록의 유형 기술문서 작성 시에 사용되는 목록의 유형은 다음과 같습니다. 글머리 기호 목록 번호 매기기 목록 포함된 목록(쉼표로 나열한 형태) 글머리 기호 목록은 항목의 순서를 변경해도 목록의 의미가 변경되지 않습니다. Bash는 다음과 같은 문자열 조작 메커니즘을 제공합니다. - 문자열 시작 부분에서 부분 문자열을 삭제합니다. - 전체 파일을 하나의 문자열 변수로 읽습니다. 하지만 번호 매기기 목록은 항목의 순서를 변경하면 의미가 변경되므로 목록에 번호를 매겨 작성합니다. 서버를 재구성하려면 다음 단계를 수행하십시오. 1. 서..
-
Technical writing Two - 문서 구조화 하기 (1)문서 유형과 개요Technical Writing 2022. 2. 22. 21:23
몇 백 페이지가 넘어가는 문서를 작성할 때 어떻게 문서를 구조화할 수 있을까요? 이번 포스팅에서는 구글 Technical writing two 과정에서 제공하는 문서 구조화하는 방법에 대해서 공부해보고 제 의견을 덧붙여 보려고 합니다. 문서 유형 구분하기 문서의 유형에 따라 긴 독립형 문서 혹은 상호 연결된 짧은 문서로 구성할 수 있습니다. 일반적으로 제조업에서 제공하는 장비 매뉴얼과 같은 문서는 긴 단일 문서로 구성되어 있습니다. IT업계에서 제공하는 개발 사이트나 위키와 같은 형식으로 구조화된 문서는 상호 연결된 짧은 문서로 구성되어 있습니다. How-to 가이드, 제품 소개 문서, 개념 가이드는 제품이나 서비스를 처음 접하는 독자를 대상으로 할 때 더 효과적이며 짧고 간략하게 작성해야 더 효과적이라..
-
Technical writing One - 간결하게 문장 작성하기Technical Writing 2022. 2. 15. 20:48
이번 포스팅에서는 테크니컬 라이팅 4원칙 중 간결성에 대해서 설명해보려고 합니다. 간결성이란 무엇일까요? 간결성이란 특정 독자가 정보를 빠르게 이해하도록 미사여구를 사용하지 않고 쉽고 간결한 쉬운 단어를 사용하는 것입니다. 소프트웨어 엔지니어는 다음과 같은 이유로 코드 줄 수를 최소화하려고 합니다. 일반적으로 코드가 짧을수록 다른 사람들이 읽기 쉽습니다. 짧은 코드는 긴 코드보다 유지 관리하기가 쉽습니다. 긴 코드라인은 에러 발생 확률이 높습니다. 기술문서를 작성할 때도 동일합니다. 짧은 문서는 긴 문서보다 더 빨리 읽히고, 가독성이 좋습니다. 하나의 문장에 하나의 주제만 작성하기 기술문서에서 지나치게 긴 문장은 독자에게 혼란을 줄 수 있습니다. 가급적이면 하나의 문장에 하나의 주제만 작성하기를 권장합니..