Docs for Developers
이 포스트는 개발자로서 지식을 정리하는 블로그를 더욱 잘 작성하기 위해 관련 서적을 읽으면서 좋은 방안을 얻기 위해 작성합니다.
모든 내용은 이 포스트에 기록 할 예정입니다.
Chapter 1. 독자 이해하기
기술 블로그를 작성하는 기준은 항상 “저”였습니다. 제가 이해하기 좋은 글이 좋은 포스트이지 않을까 생각했지만, 최근 다양한 개발자분들과 협업을 하다보니 각자 자신의 지식적 영역 내에서 생각하고 있음을 알게 되었습니다. 그 과정 중에서 저에게 한 가지가 결여 되어 있음을 알게 되었습니다. 이 책에서는 이러한 현상에 대해서 “지식의 저주”라고 표현했습니다. 개인적으로 마음에 드는 단어입니다.
“독자(청자)에 대한 이해”는 분명 더 좋은 글을 쓰는 방법으로 생각되어 큰 기대를 안고 페이지를 넘겼습니다.
사용자의 밑그림 그리기
사용자를 위해 효과적으로 문서를 작성하려면 그들이 누구이며 무엇을 달성하고 싶은지 이해해야 합니다.
위 문장을 실현하기 위해 우리는 다음과 같은 부분을 확인해야 합니다.
- 사용자의 목표가 무엇인가
- 작성자(제)가 사용자를 위해 알리고 싶은 정보(목표)도 있지만, 사용자가 알고 싶어 하는 정보(목표)를 이해하면 조사를 진행하거나 사용자에 대한 공감이 가능해지고 효과적인 정보 전달이 가능하다고 합니다.
- 사용자는 누구인가
- 상대가 주니어 개발자 일 수 있고, 프로덕트 매니저 일 수 있습니다. 이러한 경우를 잘 따져가며 문서를 작성해야 한다고 합니다.
- 만약 개발자라면 보유 기술, 사용 언어, 개발 환경, 운영 체제, 역할 등을 잘 따져가면서 적을 필요가 있습니다.
- 모든 니즈에 부합하는 정보를 전달 할 수 없기 때문에 주요 사용자를 타겟팅하는게 좋다고 합니다.