전체 글
-
Technical writing Two - 문서 구조화 하기 (1)문서 유형과 개요Technical Writing 2022. 2. 22. 21:23
몇 백 페이지가 넘어가는 문서를 작성할 때 어떻게 문서를 구조화할 수 있을까요? 이번 포스팅에서는 구글 Technical writing two 과정에서 제공하는 문서 구조화하는 방법에 대해서 공부해보고 제 의견을 덧붙여 보려고 합니다. 문서 유형 구분하기 문서의 유형에 따라 긴 독립형 문서 혹은 상호 연결된 짧은 문서로 구성할 수 있습니다. 일반적으로 제조업에서 제공하는 장비 매뉴얼과 같은 문서는 긴 단일 문서로 구성되어 있습니다. IT업계에서 제공하는 개발 사이트나 위키와 같은 형식으로 구조화된 문서는 상호 연결된 짧은 문서로 구성되어 있습니다. How-to 가이드, 제품 소개 문서, 개념 가이드는 제품이나 서비스를 처음 접하는 독자를 대상으로 할 때 더 효과적이며 짧고 간략하게 작성해야 더 효과적이라..
-
초보자를 위한 API가이드, API란 무엇일까?카테고리 없음 2022. 2. 21. 20:53
IT업계로 도전하고 싶어 공부 중에 있습니다. (기존에 Notion으로 작성된 내용을 조금씩 수정해서 티스토리에 업데이트 중입니다.) IT업계에서는 테크니컬 라이터가 API가이드를 작성한다고 하는데 API가이드가 뭐지?라는 궁금증이 생겼습니다. API가이드에 대해서 제일 친절하게 설명한 아티클 있어 제 의견을 덧붙여 번역해보고자 합니다. 원문은 페이지 하단에서 확인할 수 있습니다. 🎈오역과 의역이 있을 수 있습니다. 애플리케이션이 서로 어떻게 소통하는지 궁금한 적이 있으신가요? 애플리케이션은 Application Programming Interface(API)를 사용해 서로 대화합니다. 스포티파이를 통해 음악을 듣거나 넷플릭스에서 시청할 때마다 우리는 API를 간접적으로 사용하고 있습니다. 이 기사에서는..
-
Technical writing One - 간결하게 문장 작성하기Technical Writing 2022. 2. 15. 20:48
이번 포스팅에서는 테크니컬 라이팅 4원칙 중 간결성에 대해서 설명해보려고 합니다. 간결성이란 무엇일까요? 간결성이란 특정 독자가 정보를 빠르게 이해하도록 미사여구를 사용하지 않고 쉽고 간결한 쉬운 단어를 사용하는 것입니다. 소프트웨어 엔지니어는 다음과 같은 이유로 코드 줄 수를 최소화하려고 합니다. 일반적으로 코드가 짧을수록 다른 사람들이 읽기 쉽습니다. 짧은 코드는 긴 코드보다 유지 관리하기가 쉽습니다. 긴 코드라인은 에러 발생 확률이 높습니다. 기술문서를 작성할 때도 동일합니다. 짧은 문서는 긴 문서보다 더 빨리 읽히고, 가독성이 좋습니다. 하나의 문장에 하나의 주제만 작성하기 기술문서에서 지나치게 긴 문장은 독자에게 혼란을 줄 수 있습니다. 가급적이면 하나의 문장에 하나의 주제만 작성하기를 권장합니..
-
웹페이지를 읽는 F-Shape Pattern이란?카테고리 없음 2022. 2. 11. 17:23
Google Technical Writing 과정을 수강하면서 F-Shape Reading이라는 용어를 처음으로 접하게되었다. F-Shape Reading이란 일반적인 사용자가 웹페이지를 읽을 때 아이 스캐닝 패턴이라고 한다. 전문 기관에서 시선 추적 연구를 수행했고, 연구에 따르면 사용자의 읽기 패턴은 'F' 형태와 비슷하다는 것이다. F-Shape패턴으로 읽는다는 것은 무슨 의미일까? 일반적으로 콘텐츠를 읽을 때 (1)첫 상단에 위치한 글은 수평 이동으로 먼저 읽는다. 그리고 그 다음 단락을 살펴보기 위해 (2)왼쪽 아래(수직 형태)로 시선을 이동한다. 시선을 이동하다가 관심있는 대목이 있으면 (3)다시 수평으로 글을 읽기 시작한다. 하지만 대게는 처음 수평 이동으로 읽을 때보다 스캔하는 영역이 짧아..
-
Technical Writing One - 기술문서 명확하게 문장 작성하기Technical Writing 2022. 2. 11. 10:18
테크니컬 라이팅 4원칙에 해당하는 명확성과 연관된 명확하게 문장을 작성하는 방법에 대해서 정리해보고자 합니다. 명확성이란 무엇일까요? 명확성이란 특정 독자가 문서를 읽었을 때 내용의 모호함 없이 한 번에 이해하도록 정보를 제공하는 것이다. 어떤 문장을 읽을 때 내용이 이해가지 않아 몇 번씩 문장을 다시 읽는다는 것은 명확성이 떨어진 문장이다. 테크니컬 라이터 들은 독자들에게 정보를 명확하게 전달하는 것을 목표로 합니다. 구글에서는 테크니컬 라이팅에서 명확성은 다른 모든 규칙들보다 우선한다.라고 언급하고 있습니다. Strong verbs 선택하기 영어로 기술문서를 작성할 때 문장의 가장 중요한 부분은 동사입니다. 하지만 일부 작가는 매일 가벼운 동사만 재사용한다고 합니다. 올바른 동사를 선택하는 것은 많은..
-
작성된 문서 Rewriting하기, 퇴고, 문장의 가독성을 높이는 방법Technical Writing 2022. 2. 8. 21:36
Google Developers에서 진행하는 Free technical writing courses 4번째 정리 포스팅입니다. 마지막 포스팅에서는 실습 중간에 짧게 토론(?)을 했던 Rewriting과 Find tune에 대해서 정리하고 내 의견을 덧붙여보려고 합니다. How is rewriting different from writing? writing과 rewriting의 차이를 간단하게 말하자면 writing은 콘텐츠를 작성하는 것이고 rewritng은 작성한 콘텐츠의 구조를 재 정렬해서 깔끔하게 작성하는 것입니다. rewriting을 우리말로 직역하면 재작성인데 재작성을 '퇴고'라고 번역을 해야 할까요? 여기서 말하는 퇴고란 초안을 바탕으로 작성된 글을 수정,보완,정리 하는 작업을 뜻합니다. 문서..
-
Google Developers에서 진행하는 Free technical writing courses-3Technical Writing 2022. 2. 3. 21:35
Google Developers에서 진행하는 Technical Writing Two 수업에 참가하고 실습을 진행해본 글입니다. 구글에서 2번째 수업이 진행된다고 해서 한국시간으로 새벽 4시에 참가를 해보았다. 직접 실습을 해보고 다양한 사람들의 의견을 나눌 수 있는 기회가 얼마 없다고 생각했기 때문에 새벽 이어도 꼭 듣자고 다짐했었다.🥱 결론은 듣길 잘했다. 기술문서를 작성해보면서 적용해 볼 강의 내용들도 많고 실습으로 직접 작성해보면서 조금이라도 도움이 되었다고 느꼈다. Technical Writing One수업과 직접적으로 연결되는 내용은 없지만 미리 사이트에서 공부를 하고 One과정을 들은 후에 Two과정을 들으니 이해가 더 잘되는 기분이랄까😁 이번에도 역시 영어로 진행이 되었지만 '구글 미트'에서..
-
Google Developers에서 진행하는 Free technical writing courses-2Technical Writing 2022. 1. 19. 22:14
Google Developers에서 진행하는 Free technical writing courses를 듣고 정리한 글입니다. 이전 글은 이곳에서 확인할 수 있습니다. 이전 글에서는 토론에 대해서 정리해보았고, 이 글에서는 강의에서 진행한 실습 중 중요한 내용에 대해서 정리해보려고 합니다. Excerise 2 예시 문장을 재배열, 추가, 삭제 또는 단어를 수정해서 문장을 적절하게 개선시키는 실습을 진행했다. 정해진 정답은 없지만 강의에서 말한 내용들을 바탕으로 수정해보려고 한다. 1. The moth was removed by Grace Hopper. 첫 번째 문장은 수동태로 작성되었다. 직역을 해보자면 나방은 Grace Hopper에 의해 제거되었다.라고 번역할 수 있다. 수동태와 능동태 관련해서 공부한..