udemy "기술블로그로 알아보는 테크니컬 라이팅" 수강후기

2024년 1월 7일

| 해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다

udemy wrtiting


평소 테크티컬 라이팅에 대한 고민이 많았습니다. 개인 기술블로그에는 몇몇 글을 작성했지만 늘 아쉬움이 있었고, 항상 더 나은 글을 쓸 수 있는 방법에 대한 고민이 있었습니다. 이런 고민을 해결하고자, Udemy에서 제공하는 기술블로그로 알아보는 테크니컬 라이팅 강의를 수강하게 되었습니다.

간단히 강의에 대한 총평을 하자면 테크티컬 라이팅에 대한 기본기를 탄탄히 배울 수 있는 강의였습니다. 과거에 글을 작성하면서 느꼈던 아쉬움들을 해결할 수 있는 방법을 배울 수 있었고, 앞으로 더 나은 글을 쓸 수 있도록 도움을 받을 수 있었습니다.

📝 배운 점

강의를 듣고 인상 깊었던 내용 위주로 정리하였습니다.

독자가 누구인지 확실하게 정하자

  • 개발자인지? 비개발자인지? 어떤 직무를 가진 개발자인지?
  • 독자에 따라 설명할 기술의 깊이를 조절한다
    • 구체적인 대상 독자를 정했다면 독자의 수준에 맞는 용어와 깊이로 설명한다.

주제를 정할 때는 고려해야할 사항

  • 작성자와 독자 모두 관심이 있는지?
    • 독자가 관심이 없다면 읽을 이유가 없고, 작성자가 관심이 없다면 글을 쓸 이유가 없다.
  • 충분한 자료를 찾을 수 있는지?
  • 일정 내 쓸 수 있는지? (기한이 있는 경우)

한 편의 글을 완성도 있게 쓰려면 주제를 좁히는 것이 중요하다

  • EX

    • Github 사용법 (X)
    • Github를 사용한 효율적인 문서 검토 방법 (O)

  • 잘 아는 주제를 정한다

    • 나의 이야기를 전달하거나 직접 경험한 것을 에피소드와 사례와 함께 전달한다.

자료가 반이다

  • 메모로 소재를 꾸준히 모으자

  • 필요한 자료를 최대한 많이 찾아보고, 정리하고, 출처를 남기자

  • 자료를 찾을 때에는

    • 구체적인 근거, 사례, 데이터, 수치 등을 찾는다.
    • "왜?"에 대한 답을 찾는다.

너무 완벽하게 쓰려고하지말고 일단 자신있는 부분부터 시작하자

  • 키워드부터 시작해서 -> 문장 -> 단락 -> 챕터 -> 문서
  • 너무 짧아도, 너무 길어도 안된다. 분량은 A4용지 기준 7~10 페이지 분량이 적당하다

3C (Clear, Concise, Correct)를 지키자

  • 내용이 정확해야 한다. 정확한 사실을 전달하자
  • 수식어보다 명확하고 객관적인 데이터를 사용한다
    • EX. "매우 빠른" -> "1초에 1000건"
  • 모호하지 않게 숫자로 표현한다.
    • EX. "USB 전송 속도가 매우 향상되었다." -> "USB 2.0 최대 전송 속도는 초당 35MB로 1.1보다 40배 빠르다."
  • 분명한 글꼬리를 사용한다.
    • EX. "유일한 방법이라고 말할 수는 없지 않을 까 싶다" -> "유일한 방법은 아니다."
  • 대명사는 되도록 쓰지 않는다.
    • 명확한 지칭, 대상을 사용한다.
  • 복문보다는 단문으로 쓰고, 한자어보다는 우리말을 쓰자
  • 문서 주제의 일광성을 유지하자. 단락들이 같은 주제를 다루고 있는지 확인하자
  • 형식의 일관성을 유지하자. 각 문장들이 일관성있게 끝맺음을 하고 있는지 확인하자
  • 용어, 표현을 일관성 있게 사용하자
    • 앞에 나왔던 용어는 뒤에서도 같아야한다.
    • 문서를 여러 명이 쓰는 경우 용어집을 미리 정하자

"고치기"가 가장 중요하다

  • 전체 글쓰기 중 "40%"를 투자하자
  • 시간 간격을 두고 검토하며 고치면 객관적으로 볼 수 있다.
  • "고치기"는 맞춤법, 띄어쓰기를 고치는 것만이 아니다.
    • 전체적인 구조를 재검토하자

문서 구조는 역피라미드 구조로 작성하자

  1. 핵심 내용 요약
  2. 배경, 근거, 구체적인 설명
  3. 일반적인 내용, 참고사항

핵심 내용부터 소개한다.

  • 문서의 핵심 내용이 먼저 나와있는지 확인하자
  • 소단락에서도 핵심 내용이 먼저 나와있는지 확인하자

단어 사용에 주의하자

  • 외국어보다는 우리말을 사용하자
    • EX.
      • 익월 -> 다음 달
      • feature -> 기능
      • 퍼포먼스 -> 성능
  • 적당한 우리말이 없다면 소리나는 그대로 쓰자
    • EX. "server" -> "서버"
  • 타사 서비스, 제품등의 고유명사는 원문 그대로 쓰자
    • EX. "Google Cloud Platform" -> "Google Cloud Platform"
  • 은어 사용에 주의하자
    • EX. "API를 찌르면" -> "API를 호출하면"

✍️ 내 글에 적용하기

제가 이전에 작성했던 "Chunk load error (1) 문제이해편" 글을 다시 읽어보며 강의에서 배운 내용을 바탕으로 퇴고해보았습니다.

  • 일반적인 상황이 아닌 특정한 상황에서 발생하는 문제를 다루는 글이므로 독자를 "chunkLoadError를 경험했거나 해결하고자 하는 프론트엔드 개발자"로 구체적으로 정했어야 했습니다.
  • "JS"와 "자바스크립트"를 번갈아 사용하고 있습니다. "자바스크립트"로 용어의 일관성을 유지해야합니다.
  • "이러한 문제를 해결하기 위한..."이라는 문장에서 "이러한" 대신 구체적인 문제를 언급해야합니다.
  • "자바스크립트 번들 사이즈는 사이트 성능에 큰 영향을 미칩니다"라고 언급이 되어있는데 이를 구체적으로 언급해야합니다. 얼마만큼의 번들 사이즈가 사이트의 어떤 성능에 영향을 미치는지, 왜 그런지 등을 언급해야합니다.
  • 등등 다시 읽어보니 수정해야할 부분이 많네요... 😅

⭐️ 총평

주관적인 강의 후기입니다.

  1. 2시간 정도의 짧은 강의로 중요한 내용을 압축적으로 전달해주기 때문에 시간대비 효율적인 강의입니다.
  2. 쉬운 난이도의 강의이기 때문에 테크니컬 라이팅에 대한 기본기를 배울 수 있습니다.
  3. 테크니컬 라이팅에 대한 보기드문 "한국어" 강의입니다.
  4. 추상적인 내용보다는 구체적이고 사례와 예제를 통해 강의 내용을 이해하기 쉽게 설명해줍니다.
  5. 결론은 테크니컬 라이팅에 대해 배우고 싶은 분들에게 추천드립니다.

평소 글쓰기에 대한 책과 영상을 꾸준히 찾아보는 편인데요. 대부분은 일반적인 글쓰기에 대한 내용이었기 때문에 기술 블로그에 쓰는 글에는 곧이곧대로 적용하기는 어려웠습니다.

이 강의로 처음 테크니컬 라이팅에 대해 알게되었고 내용을 접해보았습니다. 테크니컬 라이팅이 일반적인 글쓰기와는 다른 특징이 있었고, 이런 특징들을 배울 수 있어서 좋았습니다.

항상 글쓰기에 대한 자료를 접하고 배울때마다 드는 생각이지만 실제로 글을 쓸 때 배웠던 내용을 적용하는 것이 가장 어려운 것 같습니다. 그래도 앞으로 글을 쓸 때는 이 강의에서 배운 내용을 의식하면서 써보려고 합니다.

마지막으로 추천하는 글쓰기 관련 책과 영상을 소개하면서 글을 마치겠습니다.