10장: 문서자료

최근에 문서를 관리해야 하는 일이 많아졌다. 자기소개서를 써 보기도 하고 공부한 것을 회고하기도 하며 이 문서를 내가 보기 좋게 만들지 다른 사람이 보기 좋게 만들지 생각하게 되었다. 결론적으로 말하면 문서는 타인이 보기에 좋아야 한다는 것이다. 문서의 목적은 독자에게 정보를 전달하는 것이기 때문에 간결하고 논리적이며 무엇보다 가독성이 좋아야 한다.

Chapter 10은 구글 엔지니어들이 문서를 작성하는 방법에 대해 설명한다.

구글에서 문서자료는 코드와 같이 신중하게 취급하기 때문에 Chapter 9 에서 배운 것 처럼 소유자가 리뷰 과정을 거치게 된다.

목적에 따른 문서의 종류

• 참조용: API나 규격서 등 특정 정보를 참조할 수 있게 작성한다.
• 설계: 소프트웨어 설계 및 아키텍처를 설명하는 문서.
• 튜토리얼: 기술이나 작업을 배우고 실행하는 방법을 안내하는 문서.
• 개념 설명: 개념이나 아이디어, 이론적 배경 등을 설명하는 문서.
• 랜딩 페이지: 마케팅을 목적으로 만든 웹페이지.

문서 자료의 작성 방법

• 주요 독자를 대상으로 작성햐애 한다.
• 대상 독자에게 적합한 방식으로 글을 작성하애 한다.
• 육하원칙을 지키며 작성해야 한다.
• 최초의 목표를 벗어나지 않게 작성한다.
• 버전관리를 통해 변경 사항을 추적할 수 있어야 한다.
• 문서의 정보는 정확해야 한다.

해당 챕터를 읽고 확실하게 깨달은 점이 있다면, 문서의 주체는 독자라는 것이다. 문서는 목표에 맞게 작성되어야 하며 정보 전달 후 독자의 반응에 대해 항상 생각해야 한다는 점이다. 문서도 코드처럼 의도치 않은 오류를 야기할 수 있다는 점을 잊지 말고 리뷰를 통해 문제점을 발견하고 고쳐나가야 한다는 것을 배우게 되었다.