Olivia Ha

Developer Relations

팔로우

<문서화의 6하원칙> 정새윤님이 쓰신 "문서화의 6하원칙" 글이 유용하여 요약해 봤습니다. Dable 재직 당시 Zet 팀을 리드하며 팀의 작업과 논의를 문서화했던 경험을 녹여주셨습니다. 1. Why : 문서화가 잘 된 팀은 일하기 좋은 팀 -> 견고한 문서화는 팀의 커뮤니케이션 효율을 높이기 때문 문서화는 최대 정보를 최소 시간에 공유할 수 있기 때문에 하는 거다. 2. Where : 노션과 아사나에 기록. 부득이하게 다른 형태를 취해야 하는 경우에도 노션에 해당 문서를 임베드해서 한 페이지에서 필요한 자료를 찾을 수 있도록 하고 아사나의 subtask기능을 활용하여 펼쳐진 여러 task들의 위계를 한 눈에 정리하기 3. What : task는 아사나에 task의 수행결과 및 모든 줄글 문서는 노션에 적기 4. Who : 모두 문서화는 팀원 모두가 따를 수 있도록 활용할 수 있는 '템플릿'을 제공한 상태에서 시작한다. 노션의 DB기능 적극 활용하기 5. How : - 미팅노트의 경우 : 누구나 파악할 수 있도록 객관적인 정보를 쓰고 반드시 알아야 할 결정 사항과 논의사항만 남기고 연관사항을 잘 파악할 수 있도록 태그로 어떤 피쳐, 어떤 팀과 연관되어 있는지, 어떤 단계에 연관되어 있는지 표시하기 - 업무 문서의 경우: 최대한 자세히. 누가 봐도 일의 맥락과 목적을 알 수 있도록 서술하는 것이 중요. - 문서 각각은 모두가 관여하더라도 전체적인 디렉토리를 체계화하는 일은 리드가 주기적으로. - 문서 편집에 대한 기록은 모두 오픈하여 투명하게 관리 6. When : 바로, 자주, 꾸준히 - 문서화는 미루면 망한다. - 문서는 끊임없이 업데이트하고 살펴봐야 한다. 한 번 기록하고 돌아보지 않는다면 도루묵.

문서화의 6하원칙 - 보통의 언어

보통의 언어