개발자의 글쓰기 방법 (기술 블로거의 글쓰기 방법)

상대방을 쉽게 이해시키고자, 기술 블로그를 통해서 글을 쓰기 시작했을 것이다.

 

미국의 언론인 퓰리처상의 창시자인 조셉 퓰리처의 명언을 통해서, 글쓰기의 원칙을 알아 볼 수 있다.

[그림1] 조셉 풀리처의 글쓰기 명언.

⦁ 제안하는 글쓰기의 원칙.[1]
⓵ 명확성(Clarity)
 - 독자가 문서를 읽을 때 내용의 모호함이나 혼란이 없이 한 번에 이해할수 있는 글을 작성 한다.
 - 온전한(잘 갖춰진) 문장을 작성한다. 문장을 명확히 6하원칙에 맞추어 작성하되, '중요한 것'부터 작성을 한다.
 - 모두가 알것이라고 여겨지는 용어라도, 상세하게 설명한다.
⓶ 간결성(Conciseness)
 - 독자가 내용을 신속하고 정확하게 이해할 수 있도록, 쉬운 단어와 간결한 문장을 사용한다.
 - 꾸미지 말고 있는 그대로를 간결하게 작성한다.
⓷ 정확성 (Accuracy)
 - 독자가 필요로 하는 정보를 기술적 오류 없이 정확하게 제공하는 것이다.
⓸ 일관성 (Coherence)
- 용어의 정의, 표현 어조 등을 일관성 있게 사용한다.

⦁ 힘있는 글쓰기의 요령(Power writing) [5]의 4단계.
⓵ Opinon (의견): 핵심을 주장한다.
⓶ Reason (이유): 주장에 이유와 근거를 제시한다.
⓷ Example (증명): 사례와 예시로 근거를 증명한다.
⓸ Opinon (의견): 핵심을 거듭 주장한다. (offer)

⦁ 논리 정연한 글쓰기[5]
 - 아래의 3가지 요소를 통해서, 빠르게 설득할 수 있다.
⓵ What: 무엇에 대한 이야기 인가?
⓶ Why: 왜 이것이 필요하가?
⓷ how: 어떻게 하면 되는가?

 상대방을 쉽게 이해(설득) 시키기 위해서 글을 작성했을 것이다. 위의 기본적인 요소들만이라도 잘 지켜 진다면 보다 나은 독자를 위한 글쓰기가 될것이라고 생각 된다.

참고자료:
[1]  https://tech.kakaoenterprise.com/102 , 테크니컬 라이팅 4대 원칙
[2]  https://tech.kakaoenterprise.com/174 , 테크니컬 라이터의 글쓰기 윤리
[3] https://tech.kakaoenterprise.com/125 , 퇴고의 기술
[4]  https://khwriting.khu.ac.kr/writer/essay02.php , 경희대 '글쓰기 가이드'
[5] 150년 하버드 글쓰기 비법, 유노북스