전체 글
-
[구글]에서 제공하는 엔지니어를 위한 테크니컬 라이팅 교육 사이트(Technical Writing Courses for Engineers)스터디사담 2022. 1. 9. 20:32
Technical Writing | Google Developers Technical Writing | Google Developers Technical Writing Courses for Engineers developers.google.com 구글에서는 테크니컬 라이터를 위한 교육 사이트를 제공한다. 이 과정은 일반적인 영어 글쓰기가 아니라 기술적인 글쓰기를 위한 가이드나 교육을 제공하고 있다. 학생용으로 기초적인 내용부터 담고 있지만 소프트웨어 그리고 영어에 대한 글쓰기가 부족한 나에게는 좋은 공부자료가 될 것 같아 공부해보았고, 개인적으로 작성한 내용을 블로그에 옮겨보려고 한다. IT직군의 테크니컬라이터는 git을 다룰 줄 아는 것도 중요하기 때문에 구글 테크니컬라이팅을 정리한 이후에는 gitla..
-
기술문서 어떻게 작성해야 할까? 사용자 중심의 기술문서 작성하기기술문서 2021. 10. 25. 20:44
기술문서라고 하면 다양한 문서 유형의 문서들이 존재합니다. 하지만 다양한 문서 유형일지라도 '사용자(독자)'중심으로 작성해야 한다는 것입니다. 문서로 기록한다는 것은 비록 '나' 자신일지라도 독자는 반드시 존재하기 때문입니다. 기술문서를 처음 작성할 때 어려움이 따르지만 사용자(독자) 중심으로 글을 쓰고자 한다면 쉽게 방향을 잡을 수 있을 것입니다. 사용자(독자) 중심으로 어떻게 기술문서를 작성해야 하는지 정리해보고자 합니다. 기술문서를 작성하기 전 먼저 독자는 누구인지 독자의 수준은 어떤지 고려해야합니다. 일반 사용자 그리고 초보 개발자들을 위한 문서라면 문서에 사용된 용어 자체가 쉬운 용어로 작성되어야 합니다. 그리고 사용자가 반드시 필요로 하는 내용들만 기술하도록 해야합니다. 많은 정보를 제공하는 ..
-
기술문서(Technical Document)에는 어떤 문서들이 있을까?기술문서의 종류기술문서 2021. 10. 14. 20:56
지난번 " 기술문서(technical document)의 개념/중요성/범주는 무엇일까?"에서 기술문서의 범주와 예시에 대해서 간단하게 작성했다. 이번에는 대표적인 기술문서들에 대해서 보다 자세하게 작성해보고자 한다. 정말 다양한 문서들이 있겠지만 그중 대표적이고 가장 큰 범주들에 대해서 작성하고자 한다. API Guide/SDK Gudie 사실 나는 소프트웨어 쪽이 아니라 API가이드문서에 대해서 잘 알지 못한다😥 하지만 소프트웨어 테크니컬 라이터는 API가이드 문서 등을 작성하는 일이 많기 때문에 그래도 공부할겸 알아봤다. 여기서 API가이드를 알려면 API가 뭔지를 알아야 하는데 간단하게 설명하자면 [응용프로그램에서 사용할 수 있도록 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 ..
-
Technical Writing 4단계로 기술문서 작성하기기술문서 2021. 10. 5. 15:49
테크니컬 라이팅에서 쓰이는 테크니컬 라이팅 4대 원칙에 대해서 작성해보려고 합니다. 처음 테크니컬 라이팅 교육을 수강했을 때 가장 먼저 나오는 내용입니다. 반드시 이 원칙을 따라야 할 필요는 없지만 기술문서를 처음 작성해 보는 사람이라면 이 원칙에 따라 작성하는 것이 좋습니다. 테크니컬 라이팅의 4원칙 정확성(Accuracy), 명확성(Clarity), 간결성(Concisenness), 일관성(Consistency) 1. 정확성(Accuracy) 테크니컬 라이팅의 첫 번째 원칙은 정확성입니다. 정확성이란 특정 독자가 필요로 하는 내용에 대하여 기술적 오류 없이 정확한 정보를 제공하는 것입니다. 잘못된 정보가 포함된 기술문서면 독자가 처음부터 끝까지 그 문서를 이해한다고 해도 필요 없는 정보를 제공했기 때..
-
[Typed] 새로운 문서 작성 기반 지식 관리 툴 "Typed" 사용 후기 및 사용 방법문서관리 2021. 10. 4. 15:22
📄Typed 베타 서비스를 모집해서 신청해보고 사용해본 후기입니다.📄 문서 작성과 관리 툴은 원래 '노션'만 사용했었는데 우연히 인스타그램 광고를 보고 혹해서 들어갔다. 거기에서 베타버전(?) 사용자를 신청받는다는 것을 보게되었고! 신청해서 링크를 받았다. 지금은 아래 링크에서 베타 체험으로 무료로 누구에게나 배포하고 있다. (나중에는 유료로 전환하려나?) https://www.typed.biz/?lang=ko Typed - Your Second Brain Welcome to your 2nd brain. www.typed.biz 1. Typed 툴은 무엇이고 누가 사용하면 좋을까? 그래서 Typed툴이 뭐냐! 사이트에 들어가면 자세하게 설명이 나와있지만 간략하게 설명을 하자면 '흩어져있던 자료를 모아서 ..
-
기술문서(technical document)의 개념/중요성/범주는 무엇일까?기술문서 2021. 9. 29. 20:03
기업에서 기술 문서의 중요성이 점점 대두되고 있습니다. Technical Writer의 채용공고만 봐도 작년에 비해 많이 늘어났음을 확인할 수 있고 특히 IT업계 같은 경우는 기술블로그 운영이 활발해지고 있습니다. 기술블로그 또한 기술문서의 범주에 속합니다. 기술문서는 무엇이고 어떤 문서들이 있는지 그리고 왜 기술문서가 중요한지에 대한 글을 읽고 정리해서 공유해보려고합니다. 기술 문서는 기술 정보를 최대한 효율적으로 이용할 수 있도록 작성된 문서 What is technical documentation? 기술문서란 제품을 다루는 방법, 기능, 사용법에 대한 제품 정보를 쉬운 용어를 사용해 디테일하게 설명하는 문서입니다. '기술문서'라는 게 상당히 포괄적인 의미인데, 주어진 제품의 사용방법이나 기술적인 문..
-
2.1-Technical Writer(테크니컬라이터) 채용공고 분석, 갖춰야할 역량Technical Writing/Technical Writer 2021. 9. 12. 20:17
1년..6개월 전부터 Technical Writer(테크니컬라이터)라는 직무에 관심을 가지게 되었고 이 직무로 이직하고자 마음을 먹었기 때문에 사람인을 매일매일 들어갔었다. 그렇지만 테크니컬 라이터라는 직무 자체가 대기업이 아닌이상 많이 채용하는 포지션도 아니고, 신입으로는 거의 채용하지 않기 때문에 공고는 가뭄에 콩 나듯 했다. 그래도 1년 6개월전보다 지금이 훨씬 채용공고가 많아졌다고 느낀다(직무에 대한 수요가 늘어난 걸까 아니면 그냥 우연일까?) 나도 이직을 하기 위해서 내가 어떤 역량을 갖춰야 하는지 그리고 어떤 능력들을 요구하는지 정리해보고자 한다. 우선 채용공고를 분류해보려고 한다. 1) 매뉴얼 등의 사용자 문서를 외주 받아서 만드는 회사에서 테크니컬 라이터를 채용하는 경우 2) 제품 또는 서..
-
1-Technical Writer(테크니컬 라이터)직무에 대해서Technical Writing/Technical Writer 2021. 8. 26. 20:39
처음 사회 생활을 시작했을때 Technical writer라는 직군이 있는지 조차 몰랐었다. (지금도 사실 생소하다. 주변에 말하면 '그게뭐야?' 라는 반응이 대다수다. ) 내가 하고 있는 일에 전문성을 키우기 위해서 technical writer 교육과정을 찾아 들었고 이쪽길로 가야겠다고 결심했다! 이직을 하고 테크니컬 라이터로서 일은 하고 있지만 아직 나조차도 개념이 생소하기 때문에 하나씩 정리해보려고 한다. #1 Technical writer가 뭔데? 위키백과에 테크니컬 라이터라고 검색을 해보았다. 테크니컬 라이터(technical writer)는 전문적인 정보를 전달해주는 역할을 한다. 어떤 시설이나 장비에 대한 정보를 여러 사람에게 전달해주는 역할이다. 그 정보는 다양한 매체를 통해 다른 사람들..