본 글은 Google Developers 에서 제공하는 Technical Writing For students 자료를 바탕으로 한국어로 번역/정리한 글입니다.
원문은 다음 링크에서 확인할 수 있습니다. https://developers.google.com/tech-writing/overview
Overview of technical writing courses | Technical Writing
The following table summarizes the technical writing courses: Title Summary Pre-Class In-Class Technical Writing One Learn the critical basics of technical writing. Take this course before taking any of the other courses. 2 hours 2 to 2.5 hours Technical W
developers.google.com
또한 본문은 For Students 코스를 번역/정리하였으며 원문 사이트에서 더 많은 자료를 확인할 수 있습니다.
본 글은 기술 블로그 및 기술 관련 글 정리에 도움이 되고자 원문을 참고하여 번역 및 정리하였습니다.
원문에서는 코스 형태의 수강 방식으로 글을 정리하였지만 본문에서는 최대한 글쓰기의 팁과 방법 설명 위주로 작성했습니다. 또한 불필요하게 설명된 부분은 과감히 제거하고 정말 필요하고 도움이 되는 부분만 정리하였으며 직역을 지양하고 유동적으로 다르게 해석하여 정리한 부분이 있음을 알립니다.
개요
원문 사이트에 접속하게 되면 위 사진과 같은 테크니컬 라이팅 코스에 대한 개요를 확인할 수 있습니다.
테크니컬 라이팅 코스는 One 과 Two 두가지 과정으로 진행됩니다.
본 For Students 코스는 소프트웨어 엔지니어 혹은 소프트웨어 및 CS를 학습하는 학생들을 대상으로 제작되었습니다.
Technical Writing One
글쓰기의 조건
적어도 이 과정에서 타겟으로 하는 학생들은 기술 관련 글을 쓰기 위해 최소한의 작문 역량은 필요하지만, 그렇다고 뛰어난 작가가 되려고 할 필요는 없다고 설명합니다.
그냥 써라. 당신은 작가가 아니다.
글쓰기 기본 규칙
본 과정에서 학습목표로 나열한 가장 기본적인 글쓰기 규칙은 다음과 같습니다.
- 용어 및 약어를 일관되게 사용할 것
- 대명사를 모호하게 사용하지 말것
- 능동과 수동을 구분할 것
- 되도록 수동형보다 능동형으로 작성할 것 : 능동형이 수동형보다 우수한 점은 (2)편에서 설명합니다.
- 문장을 더 명확하고 몰입감 있게 작성할 수 있는 전략을 사용할 것 : 세가지 전략에 대해 (2)편에서 설명합니다.
- 문장을 압축할 수 있는 방법을 사용할 것 : (2)편에서 설명합니다.
- bulleted list와 numbered list의 차이를 구분하고 사용할 것
- 단락(절)에서 lead 문장을 작성할 것
- 각 단락(절)은 하나의 주제에 집중할 것
- 글의 시작 부분에서는 먼저 핵심 사항을 기술할 것
- 타겟 오디언스를 인식할 것
- 타겟 오디언스가 이미 알고 있는 것과 배워야 할 것을 결정하고 기술할 것
- 지식의 저주(curse of knowledge)에 대해 이해할 것
- 관용구를 인식하고 수정할 것
- 글의 범위 및 목표와 대상을 명시할 것
- 긴 주제는 적절히 섹션을 나눌 것
- 쉼표, 괄호, 콜론 등 특수 기호를 적절히 사용할 것
- Markdown 사용 능력을 개발할 것
뛰어난 엔지니어 또는 기술 작가가 되기 위해서는 수 년의 걸친 집중적인 연습이 필요하다.