Technical Writing
-
개발자 초안 어떻게 다듬어야할까?(with NotebookLM)Technical Writing 2025. 7. 27. 18:47
제가 속한 조직에서 기술블로그를 운영하기 시작하면서 개발자가 작성한 게시글의 초안을 검토하는 일이 늘어났습니다..!충분한 시간을 가지고 개념 위주의 글만 쓰던 것과는 다른 형식의 글이고 기술블로그 타깃독자가 개발자다 보니 비개발자인 제가 이해하기 어려운 경우가 많았습니다. 최대한 '작가'의 개성을 살리고자 게시글을 작성할 때는 간단한 템플릿을 제공하고, 작가가 작성하면 저희 팀에서 가독성 측면에서(간혹 정말 안 읽히는 일부 문장들 정도...) 수정하거나 내용이 부실할 때는 보강을 요청하기도 합니다. 최근에는 비교적 작가분들이 잘 작성해 주셨기 때문에 몇몇 문장과 내용 보강 정도만 요청했으나 제가 모르는 내용에 대해서 피드백을 주는 것은 은근히 어려운 작업이었습니다. 그래서 이번 포스팅에는 제가 새롭게 사..
-
개념을 설명하는 글쓰기 경험 회고하기Technical Writing 2025. 6. 22. 21:11
처음 지금 다니고 있는 회사에 입사했을 때, 제 주된 업무는 기술 개념서를 작성하는 일이었습니다. 지금은 전략 업무를 맡고 있어 이 일을 지금도 하고 있지는 않지만, 돌아보면 그 시기에 제가 만들었던 문서들이 나름 의미있는 결과물 중 하나였다고 생각합니다. (솔직히 말하자면 그 시절의 업무에 더 집중하고 싶다는 마음이 아직도 제 안 어딘가에 남아있기도 해요😉) 한동안 구성원을 위한 기술 개념서를 쓰는 일을 맡았고 그 과정에서 기술을 설명하는 글쓰기는 개념을 설계하는 일이라고 생각했습니다.개념을 설계하는 일?제가 쓴 문서는 사용자 매뉴얼도 아니고, 대외 홍보용 화이트페이퍼도 아니었습니다. 내부적으로는 ‘기술백서’라고 불렀지만 여기서는 조금 더 정확하게 이렇게 설명하면 이해가 쉬울 것 같네요.“새로 입사한..
-
테크니컬 라이팅과 전략업무의 공통점이 있을까?Technical Writing 2025. 6. 4. 15:08
어쩌다 보니 기술문서를 주로 작성하는 업무를 맡게 되면서 ‘테크니컬라이터’라는 직군이 있다는 걸 알게 되었습니다. 처음 사용자 매뉴얼을 작성하게 됐을 땐 이게 과연 전문성이 있는 일일까 하는 의문도 들었지만 막상 해보니 저와 잘 맞았습니다.🧚♀️예전부터 글쓰기를 어렵게 느끼진 않았습니다. 그래서 ‘이 일도 크게 어렵진 않겠지’ 싶었지만 기술문서를 작성하는 건 고등학교나 대학교에서 하던 글쓰기 과제와는 (당연하게도) 전혀 다른 차원의 일이었습니다. 여러 사람들과 협업하고 팩트를 체크해야되는 과정이 글을 쓰는 시간보다 훨씬 길었고, 문서 전체의 구조를 생각하는 건 생각보다 쉽지않았습니다. 어떻게 하면 더 잘할 수 있을지 고민하다 보니 관련 강의도 찾아 듣게 되었습니다. 당시에는 정보가 거의 없었는데 운 ..
-
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장 이내의 짧은 문서라면 목차를 반드시 작성하지 않아도 되지만 매뉴얼과 같이 몇 백 페이지가 넘어가는 긴 문서는 목차를 작성해주어야 독자가 피요한 정보를 빠르게 찾을 수 있습니다. 매뉴얼 작성 시에 항상 생각해야 하는 것 중에 하나는 긴 매뉴얼..