Search

기술블로그로 알아보는 테크니컬 라이팅

작성일
2024/03/31 07:57
원문링크
https://developnote-blog.tistory.com/204

요약

작성자는 개발자 글쓰기 커뮤니티인 글또 9기에 참여중
이번 기수의 다양한 혜택중 하나인 Udemy에서 강의를 경험해봄
그 중에서 기술블로그로 알아보는 테크니컬 라이팅을 수강함
작성자는 개발 블로그를 운영중이지만 글과 관련해서 피드백을 받을 기회가 적다.
업무에서는 메뉴얼, 제안서 등 다양한 종류의 문서를 작성
블로그에는 개발 관련 글을 포스팅
글쓰기 스킬 향상에 대한 필요성을 느낌
강사는 20년 경력의 테크니컬 라이팅 코치 유영경
강의는 총 2시간 분량
5개의 챕터로 구성됨
1.
테크니컬 라이팅의 개념과 문서 작성 프로세스
2.
독자를 선정하고 주제를 잡는 방법
3.
초안 작성하기
4.
문서 고치기
5.
동료 검토와 문서 배포하기

명확, 간결, 일관되게 쓰기

글쓰기 원칙 3C
Clear → 명확
Concise → 간결
Consistent → 일관
명확하게 표현하기란 정확한 내용과 선명한 문장으로 확실하게 표현

수식어보다 명확하고 객관적인 데이터를 사용

작성자는 평소에 매우, 아주, 많이 등 수식어를 사용

분명한 글꼬리 사용

작성자는 말할 때나 글을 쓸 때 ‘~인 것 같다.’ 라는 어미의 표현을 자주 사용
불필요하게 글이 길어짐
표현에 확신이 드러나지 않음
~이다. 로 고치는게 좋다.
계속 성장할 것이라 판단되는 바이다 → 계속 성장할 것입니다.

대명사는 되도록 쓰지 않는다.

작성자는 반복적인 표현을 지양하기 위해 되도록이면 대명사를 사용해서 글을 써옴
강의에서는 문학이 아닌 기술 글쓰기에서는 특정 부분만 읽어도 파악할 수 있게 직접 명사를 쓰는게 좋다고 말함

링크 이름을 대명사로 쓰지 않는다.

여기를 참조하세요 → 오류 코드 목록을 참고하세요
링크로 리다이렉팅한 글의 제목을 적는다.

후기

내용이 생각보다 별로 없다.
강의를 들은걸 정리하는 글보다는 후기에 가까운듯 하다.
다시 보니 제목이 Udemy 후기였다.
명확, 간결, 일관되게 쓰기에서 각 단어가 의미하는 바를 명시하는게 더 좋았을듯 하다.
궁금증을 일으키는 목적이라면 좋은 수단인듯?
후기를 작성하려고 했는데 가입이 너무 귀찮았다. 블로그 이름과 링크까지 만들어야 한다니…
나도 다 읽고나서 강의를 듣는것도 꽤 괜찮다고 생각중이다.