Writing the Docs - P.O.W.E.R Writing 정리

19.05.28일에 진행된 Writing the Docs 밋업에서 김지현 님의 발표를 정리한 글입니다.

P.O.W.E.R Writing이란

글쓰기의 5단계인 Preparing, Organizing, Writing, Editing, Reviewing을 줄여서 부르는 말이다. 글을 잘 쓰는 사람들이 중요하게 여기는 단계는 Editing과 Reviewing으로서 글쓰기 이전 단계를 거치지 않고 바로 글을 쓰거나 글을 쓴 후 교정하고 검토하는 과정 없이 마치는 경우도 많아서 Editing과 Reviewing을 많이 강조하셨다.

Preparing

글쓰기 전 준비하는 단계로서 주제, 독자, 개요를 생각해야 한다. 모두 중요하고 고려해야 할 대상이지만 독자를 많이 강조하셨다. 독자에 따라 내용이 달라지기 때문이다.

Organizing

준비 단계에서 주제와 줄거리 그리고 독자를 선정한 후 목차, 논리적 순서를 짜는 단계이다. 여기서 사용할 수 있는 방법으로는 Mind Map과 Pyramid Principle이 있다. 둘 다 생각을 정리하는 데 도움이 된다. 마인드맵은 주제를 두고 자유롭게 생각나는 것들을 적은 후, 연관되는 것들을 확인할 수 있다. Pyramid Principle은 국내에는 ‘논리의 기술’이라는 제목으로 번역된 바바라 민토의 논리적인 문서 작성법에 대한 책에 포함된 내용으로서 마인드맵과는 또 다른 방법으로 글을 구성하는 데에 도움을 준다.

Writing

준비와 구성을 마친 후 글을 쓸 때는 Editing 과정과 구분하도록 하여야 한다. 글을 쓸 때는 글쓰기에만 집중하고 교정은 Editing 단계에서 하도록 한다.

Editing

글을 다듬는 단계로써 4가지 원칙에 맞추도록 한다.

• 정확성
  • 정보, 문법
  • 개발 분야는 업데이트와 새로운 기술이 나오는 경우가 빈번하므로 올바른 정보인지 확인해야 한다.
  • 부산대 맞춤법 검사기를 이용하여 맞춤법을 확인하도록 한다.
  • 영어는 Language Tool을 이용할 수 있다. (Grammarly는 글 내용을 Grammarly 측에서 사용할 수 있으므로 비추)
• 일관성
  • 용어, 어투
  • 대화할 때는 단어나 표현이 달라져도 문제 되지 않지만, 글을 쓸 때에는 용어가 일관되도록 해야 한다.
  • 마찬가지로 어투도 일관되어야 한다.
• 간결성
• 보편성
  • 누구나 알 수 있도록 해야 한다.
  • 지식의 저주(The curse of knowledge)란 개인이 다른 사람과 의사소통을 할 때 다른 사람도 이해할 수 있다고 자신도 모르게 추측하여 발생하는 인식적 편견이다.
  • 독자가 이해할 수 없는 축약어는 사용하지 않도록 한다.
  • 예) 사내에서 사용하는 용어

Reviewing

자가검토와 동료검토를 할 수 있는데 자가검토를 할 때 아래의 방법을 따르도록 한다.

1. 충분한 휴식 취하기
2. 출력해서 보기
3. 소리 내 읽기

출력해서 보면 글을 쓸 때는 보지 못했던 부분을 더 잘 볼 수 있고 소리 내 읽기는 쉽지는 않은 방법이지만 더 객관적으로 볼 수 있을 것이다.

추천 도서

• 논리의 기술(바바라 민토)
• 내 문장이 그렇게 이상한가요(김정선)