학부 프로젝트 문서 작성, 팀 인수인계 문서 경험
학부 프로젝트에서 팀원이 바뀔 때 인수인계 문서를 처음 작성했습니다. 내가 알고 있는 것을 쓰다 보니 읽는 사람 기준이 아닌 쓰는 사람 기준으로 내용이 채워졌고, 인계 받은 팀원이 이해하기 어렵다는 피드백을 받았습니다. 이후 독자가 무엇을 모르는 상태에서 읽는지를 먼저 생각하고, 배경 설명을 앞에 두는 구조로 다시 썼습니다. 실제 작동하는 예제를 포함하면 이해 속도가 크게 빨라진다는 걸 그때 배웠습니다. 문서는 완성 후 바로 낡기 시작하기 때문에 갱신 기준과 주기를 함께 적어두는 것이 장기적으로 유효하다는 것도 알았습니다.
좋은 문서는 독자가 스스로 다음 단계를 찾아갈 수 있도록 연결 고리를 만들어주는 것이라는 걸 배웠습니다. 이후 저는 문서를 쓸 때 독자 페르소나를 먼저 정하는 습관이 생겼습니다. 누가 읽느냐가 무엇을 쓰느냐를 결정한다고 생각합니다.