[자기개발/개발자] 개발자로서의 글쓰기 연습 #18

Chapter5.2 - 정확히 이해하도록 그림과 글로 묘사하자

---

글에 묘사를 더하면 이해가 빠르다

• 단순한 언어보다는 묘사를 위한 오감 추가하기

글과 그림의 내용을 일치시키자

• 그림에 있는 단어를 사용하여 글을 쓰기

객관적 묘사와 주관적 묘사 둘 다 하자

• 주관적 묘사와 객관적 묘사의 방식을 자유자재로 왔다갔다 할 수 있으면 개발이 쉬워짐

Chapter5.3 - 논증으로 유용한 정보를 제공하자

---

의견을 쓰려면 근거를 대자

• 논증의 기법 활용하기
• 개발자가 의견만 말하고 근거를 말하지 않으면 독자가 직접 테스트해볼 수 밖에 없음

거칠게도 공손하게도 쓰지 말자

• ~할 수 있지만 ~하기 어렵다, ~ 해야 합니다만 반드시 해야하는 것은 아닙니다 -> ~하십시오, ~하지 마십시오
• 100% 확신은 불가능하지만 여지가 있다면 독자는 이를 부풀리는 경향이 있음

주장과 이유의 거리를 좁혀서 쓰자

• 개발문서는 필요한 부분들만 읽기 떄문에 주장과 이유가 붙어있어야 함

문제와 답의 거리를 좁혀서 쓰자

• 답을 찾기 위한 과정은 지루할 뿐
• 필요한 문장만으로 나타낼 수 있음

참고문헌: 개발자의 글쓰기