전체 글
-
Technical Writing One - 능동태와 수동태Technical Writing 2022. 1. 13. 15:11
영문 기술 글쓰기에서는 수동형보다 능동형으로 문장 쓰기를 권장한다. 번역을 할 때도 마찬가지로 수동형으로 작성된 영어 문장을 능동형으로 번역하는게 자연스러운 경우가 많다. 이전에 번역 강의를 잠깐 들은 적이 있는데 이해를 돕기 위해 예시를 하나 들어보자면 A pile of dirty cloths were frowned at by visitors. 이 문장을 직역했을 때 더러운 옷더미들은 방문자들의 눈을 찌푸리게 했다. 가 된다. 하지만 이렇게 번역을 하면 한눈에 봐도 어딘가 어색한 문장이라는게 느껴진다. 이를 능동형으로 더러운 옷더미에 방문자들은 눈살을 찌푸렸다. 라고 번역을하면 이전보다 훨씬 자연스럽게 느껴진다. 능동태와 수동태 예시 간단한 active voice 예제 문장은 다음과 같다. The ca..
-
Google Developers에서 진행하는 Free technical writing courses-1Technical Writing 2022. 1. 12. 20:29
Free technical writing courses | Technical Writing | Google Developers Free technical writing courses | Technical Writing | Google Developers Send feedback Free technical writing courses Every software engineer is also a writer. Improve your technical writing skills by taking one of Google's free technical writing courses. We've aimed these courses at people in the following roles: professional ..
-
Technical Writing One - 단어 올바르게 사용하기Technical Writing 2022. 1. 11. 21:17
기술문서를 작성할 때 '단어'선택이 중요하다. 특히 어려운 기술을 처음 접하는 독자에게 쉽게 풀어서 설명하는 것은 어렵다. 작성하는 사람이 완벽하게 그 기술을 안다고 해도 남에게 쉽게 설명하는 것은 쉽지 않다. 특히 어려운 전문용어들을 남발하여 사용하는 것은 바람직하지 않다. 구글 테크니컬라이팅에서 권장하는 단어 사용법에 대해서 공부하고자 한다. 새로운 용어 또는 익숙하지 않은 용어 정의 용어가 이미 사용되고 있는 경우에는 기존에 작성된 설명에 링크합니다. 문서에서 처음 사용되는 용어라면 그 용어에 대해 정의합니다. 만약 문서에서 새로운 단어들을 많이 사용한다면 해당 단어들을 용어집에 정리합니다. 일관된 용어 사용과 약어를 올바르게 사용하기 일관된 용어를 사용하는 것은 독자가 문서를 읽을 때 흐름이 끊기..
-
[구글]에서 제공하는 엔지니어를 위한 테크니컬 라이팅 교육 사이트(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툴이 뭐냐! 사이트에 들어가면 자세하게 설명이 나와있지만 간략하게 설명을 하자면 '흩어져있던 자료를 모아서 ..