-
테크니컬 라이팅 강의를 듣고나서글또 2024. 1. 6. 12:09
https://www.udemy.com/course/techwriting/ 0. 들어가며
안녕하세요.
이번 글은 유데미에서 지원을 받아 강의 시청 후 작성하게 되었습니다.
제가 수강한 강의는 "테크니컬 라이팅"이라는 강의입니다.
사실 이 강의를 듣고 나서 작성한 글이 있는데요.
바로 "재고 정합성이 걱정되어서 써보는 글"입니다.
제가 참고했던 부분을 하나씩 보여드리고자 합니다.
1. 대명사는 되도록 쓰지 않는다.
"명확하게 쓴다" 챕터 중 하나인 "대명사는 되도록 쓰지 않는다"부분입니다.
대명사를 쓰는 것은 일반 문학에서는 어색하지 않습니다.
하지만 기술 글에서는 특정 부분만 읽었을 때 바로 문맥을 파악할 수 있어야 합니다.
활용 이전 글에서는 대명사를 쓰지 않으려고 노력했습니다.
코드의 중복을 줄이는 것처럼 대명사를 많이 썼었는데 강의를 듣고 수정했습니다.
대명사를 많이 사용하는 부분은 링크 부분입니다.
이는 참고할 페이지의 이름을 직접 써 주는 것이 좋습니다.
2. 단문으로 쓴다.
초안을 쓰다 보면 두서없이 길게 쓰게 됩니다.
일반 글쓰기에서는 멋있게 보일 수 있지만 기술글에서는 짧게 쓰는 것이 글의 리듬감을 줄 수 있습니다.
전부 툭툭 끊어서 쓰는 것이 아닌 중간을 지키려고 했습니다.
읽었을 때 어색함이 느껴지지 않는 선에서 끊었습니다.
3. 일관되게 쓴다.
글을 쓰다 보면 이전에 썼던 용어를 다르게 설명할 때가 있습니다.
보통 저는 초안을 쓸 때 많이 발생하는데요.
트랜잭션과 Transaction을 혼용해서 쓰지 않고 트랜잭션으로 통일을 했습니다.
글을 읽다가 잠깐이나마 멈칫하는 시간을 줄일 수 있습니다.
4. 고치기
전체 글 쓰기 시간의 40%를 고치기에 넣는 것이 좋습니다.
글쓰기의 완성은 고치기에서 온다고 봅니다.
그렇기에 글을 쓸 때 다음과 같은 생각은 버려야 합니다.
- 초안 작성이 끝이라는 생각하는 것
- 맞춤법과 띄어쓰기에만 집중하는 것
- 쓰자마자 검토하는 것
- 공개하지 않고 혼자만 검토하는 것
저는 초안을 대충 쓰고 나서 여러 번 고치는 방법을 사용합니다.
이게 하나의 주제에 오랫동안 집중할 수 있다고도 생각합니다.
중요한 글의 경우는 프린트까지 해서 읽곤 하는데 이것도 좋은 방법이라고 합니다.
마무리
강의를 무료로 볼 수 있어서 좋은 기회였습니다.
글을 쓰면서 이게 맞게 쓰는 건가 하는 의문점들이 있었는데 강의를 통해서 올바르게 쓰는 것을 배울 수 있었습니다.
더 많은 내용이 강의 속에 있으니 참고 바랍니다.
'글또' 카테고리의 다른 글
유데미 개발자 영어 (0) 2024.02.03 spring cache 커스텀으로 성능개선하기 (0) 2024.01.21 Spring Async에서 SecurityContextHolder 접근하기 (0) 2023.11.04 spring security white list 어노테이션 만들기 (0) 2023.11.01 Spring kafka에서 Multi Type Converter 여행기 (0) 2023.09.25