개발자의 글쓰기를 읽은 후, 테크니컬 라이팅에 관심이 깊어졌습니다.
그러다 7월 우아한 테크 세미나에서 이 책을 접하게 되었는데요.
함께 제공되는 다양한 실무 사례들이 유용해서 좋았습니다.
무엇보다 책부터가 테크니컬 라이팅 그 자체라 글의 구조가 정돈되었고요.
다만 평소 글쓰기에 관심이 많던 저에겐 이미 알고있던 원칙들도 많았어요.
하지만 몇몇 원칙들은 제가 오랫동안 고민한 부분에 대해 명쾌하게 해결해줬습니다.
그래서 두고두고 읽기 좋은 책이라 생각이 듭니다.
역피라미드 글쓰기 (ch.08)
글쓰기에서 제가 정말 정말 중요하게 여기는 원칙이 바로 '두괄식'입니다.
이 '두괄식'을 활용한 대표적인 글쓰기 방식이 '역피라미드 글쓰기'입니다.
'역피라미드 글쓰기'는 중요한 내용부터 덜 중요한 내용까지 차례로 배치하는 방식입니다.
즉 글이 '결론', '핵심', '주제'로 시작하여 '근거', '데이터'로 끝내는 구조를 갖게 되는 것이죠.
'역피라미드 글쓰기'는 무려 100년 이상을 기사 작성 방식의 표준으로 활용되었습니다.
오랜 시간 검증되었기 때문에 테크니컬 라이팅에서도 이를 활용하게 되었고요.
독자는 '역피라미드 글쓰기'에서 아래와 같은 이점을 얻을 수 있습니다.
- 요점을 파악하는 데 짧은 시간이 걸립니다.
- 주제를 빠르게 파악하여, 이후의 세부 내용을 이해하기 쉽습니다.
- 끝까지 읽지 않더라도 핵심을 파악할 수 있습니다.
- 필요한 장이나 절을 골라 읽기 쉽습니다.
객관적 근거 (ch.11)
'객관적 근거'가 글의 신뢰도를 높여준다는 건 대부분이 아는 사실입니다.
다만 저는 '참고 자료를 명시'하는 정도로 한정적인 활용을 하고 있었습니다.
'객관적 근거'는 모호하거나 추측성을 가진 모든 문장에 널리 활용할 수 있습니다.
특히 이력서를 쓸 때 많이 강조되는 부분이기도 하고요.
- 👎 : 기존 서버보다 파일 로딩 속도가 빨라졌습니다.
- 👍 : 기존의 1.5초의 서버 로딩 시간을 0.9초로 단축시켰습니다.
- 👎 : 얼마 전까지 A 라이브러리는 실무 도입에 어려움이 있었습니다.
- 👍 : 정식 버전이 릴리즈 되기 전까지 A 라이브러리는 실무 도입에 어려움이 있었습니다.
일관된 용어 (ch.14)
책에서 가장 인상적이던 원칙 중 하나였습니다.
예전에 글쓰기에 관심이 많아 다양한 책과 강의를 찾아본 적이 있었거든요.
'일반적인 글쓰기'에서는 글의 단조로움을 피하고자 '다양한 어휘'의 사용을 강조합니다.
반면 '테크니컬 라이팅'에서는 '일관된 용어'의 사용을 강조합니다.
독자가 혼동할 만한 부분을 최대한 없애야 하기 때문입니다.
추가로, 되도록 영어보다는 한글을 일관되게 사용합니다.
- Load balancer → 로드 밸런서
- instatnce → 인스턴스
- 시큐리티 그룹 → 보안 그룹
마지막으로, 행동을 나타내는 동사 또한 일관되게 사용합니다.
- 앱을 선택합니다
- 앱을 누릅니다
- 앱을 탭 합니다
- 앱을 터치합니다
위의 네 단어는 모두 같은 동작을 나타내고 있습니다.
어떠한 단어를 선택해도 상관없지만, 하나를 정했다면 일관되게 사용합시다.
대명사 지양하기 (ch.26)
우리는 같은 단어의 반복을 피하기 위해 대명사를 활용합니다.
하지만 테크니컬 라이팅에서 대명사를 사용하는 것은 좋지 않습니다.
대명사가 무엇을 가리키는지 명확하게 알기 어렵기 때문입니다.
- 👎 : 더 많은 API 사용법은 여기를 참고하시기 바랍니다.
- 👍 : 더 많은 API 사용법은 API 레퍼런스를 참고하시기 바랍니다.
추가로, '이를 통해'라는 대명사를 사용하지 않습니다.
- 👎 : 캘린더를 사용하면 쉽게 일정을 공유할 수 있습니다. 또한 이를 통해 프로젝트도 관리할 수 있습니다.
- 👍 : 캘린더를 사용하면 쉽게 일정을 공유할 수 있습니다. 캘린더에서 프로젝트도 관리할 수 있습니다.
단정적인 어조 (ch.29)
한국 사람들이 가진 언어 습관 중 하나는 '추측성 어조'입니다.
'~것 같습니다', '~듯합니다', '~하게 됩니다' 등이 대표적이죠.
테크니컬 라이팅에서 '추측성 어조'는 글의 신뢰성을 떨어뜨립니다.
일반적인 글이나 일상 대화에서도 '추측성 어조'는 자신감을 낮아 보이게 만들죠.
테크니컬 라이팅에서는 '추측성 어조'가 아닌 '단정적인 어조'를 사용합니다.
- 👎 : 열기를 클릭하면 새 창이 열리게 됩니다.
- 👍 : 열기를 클릭하면 새 창이 열립니다.
- 👎 : useCallback을 사용하면 성능이 더욱 좋을 것 같습니다.
- 👍 : useCallback을 사용하면 성능이 더욱 좋습니다.
예제를 보면 느끼지만 '단정적인 어조'는 어느 정도 지식이 뒷받침되어야 하네요.
우리는 굳이 '추측성 어조'를 안 써도 될 상황에서 남용하는 걸 조심하면 좋겠습니다.
문장 다이어트 (ch.32-40)
테크니컬 라이팅을 공부할수록 '절대 필력을 자랑하는 분야가 아님'을 느낍니다.
사실 과거에 있어 보이는 문장을 만들기 위해 어렵게 썼던 적이 많았거든요..
테크니컬 라이팅의 문장은 최대한 간결해야 합니다.
문장이 길어지면 호응 관계가 어긋나기 쉽고, 파악도 어렵기 때문입니다.
간결한 문장을 만들기 위한 원칙은 셀 수 없이 많이 존재합니다.
수많은 원칙을 암기하는 것보단 '비판적인 시각으로 문장을 바라보는 습관'이 더욱 중요하다고 느낍니다.
몇 가지 유용한 원칙들을 정리해보았습니다.
사소한 조사를 제거합니다.
- 제공이 되며 → 제공되며
- 사용하실 수 → 사용할 수
군더더기 단어를 제거합니다.
- 👎 : 인증서 도메인당 월 8만 원의 비용이 발생합니다.
- 👍 : 인증서 비용은 도메인당 월 8만 원입니다.
- 👎 : 다운로드를 진행해 주세요.
- 👍 : 다운로드해 주세요.
- 👎 : 로그인이 필요합니다.
- 👍 : 로그인해야 합니다.
수동태가 아닌 능동태로 작성합니다.
- 👎 : Python은 귀도 반 로섬에 의해 개발되었습니다.
- 👍 : Python은 귀도 반 로섬이 개발했습니다.
특히 '이중 피동'은 문장을 훨씬 어렵게 만드는 원인입니다.
- 👎 : 결과 로그가 화면에 보여집니다. (보이다 + -어지다)
- 👍 : 결과 로그가 화면에 나타납니다.
알게 모르게 익숙해져 있는 '번역체'들을 제거합니다.
- 👎 : 자바스크립트 성능에 대해 알아보자 (about)
- 👍 : 자바스크립트 성능을 알아보자
- 👎 : 성능을 향상시키는 것은 코드 스타일을 다듬는 것에 의해 이뤄질 수 있다. (by)
- 👍 : 코드 스타일을 다듬어 성능을 향상할 수 있다.
- 👎 : 성능 향상은 다음 3가지 방법을 통해 가능하다. (through)
- 👍 : 성능 향상은 다음 3가지 방법으로 가능하다.
- 👎 : 성능 향상은 다음 3가지 방법으로 가능하다. (possible, impossible)
- 👍 : 성능은 다음 3가지 방법으로 향상할 수 있다.
- 👎 : 모바일 기기들은 기종별로 다양한 해상도를 가지고 있다. (have)
- 👍 : 모바일 기기의 해상도는 기종별로 다르다.
따옴표 (ch.45)
따옴표는 각각의 사용 목적을 올바르게 이해한 뒤 사용해야 합니다.
큰따옴표
- 낱말이나 문장을 직접 인용할 때
- 책 제목, 신문 이름을 나타낼 때
작은따옴표
- 문자의 중요한 부분을 강조할 때
- 소제목, 작품, 상호 등을 나타낼 때
요즘 글을 쓰면서 이 책의 원칙들을 정말 자주 적용하고 있어요.
글이 좀 더 간결해지고 일관된 느낌이 들어서 뿌듯하니 좋네요 😙
'기타 > 독서' 카테고리의 다른 글
| [독서] GRIT(그릿) (0) | 2022.09.27 |
|---|---|
| [독서] 마지막 몰입 (0) | 2022.09.26 |
| [독서] 조엘 온 소프트웨어 (0) | 2022.08.21 |
| [독서] 부자 아빠 가난한 아빠 1 (0) | 2022.08.18 |
| [독서] 스타트업 리스크 - 어느 창업가의 고백 (0) | 2022.08.09 |