채병주

학생

팔로우

🆕 새로운 개발자가 팀에 합류한다는 건 실로 엄청난 일이 아닐 수 없다. 처음 입사하게 되면 회사 자체의 매뉴얼도 알아야 하고, 그 와중에 업무 파악도 하면서 개발 분위기도 파악해야 한다. 와중에 봐야 할 문서도 흩어져 있으면 입사자는 큰 어려움을 겪을 것이다. 📚 신규 입사자를 위해 팀에서 필요한 정보를 모아서 룰은 룰 별로, 팁은 팁 별로 나누자. 문서화 작업을 할 때는 몇 가지 규칙을 지키는 것이 좋다. 1. 지금 당장 필요한 최소한의 주제 위주로 작성한다. 2. 나중에 알아도 되는 것은 "처음이신가요?" 문서에 링크하지 않는다. 3. 최대한 문서를 업데이트 하지 않아도 되도록 작성한다 4. 궁금한 부분이 생기거나 잘 안될 경우를 위해 바로 컨택할 수 있도록 관련 팀원을 태크해둔다. 👮 개발을 하며 규칙이 많다는 것은 관리가 잘 되고 있다는 뜻이다. 규칙이 적을수록 코딩은 자유롭겠지만 함께 일하는 팀원들이 모두 나와 같은 생각을 가지고 있지는 않다. 팀원이 늘어날수록 모두가 합의한 하나의 규칙이 있다면 훨씬 도움이 될 것이다. 🧠 정리를 하다보면 다시 머릿속에 내용이 정리된다. 마음가짐을 다시 챙길 수 있을 뿐만 아니라, 스터디 내역 등도 정리하여 문서화하지 않으면 스터디 내용이 잘 기억에 남지 않을 수 있다. 💻 개발 문서를 멋있게 쓸 필요는 없다. 군더더기 없이 핵심 부분만 요약하고, 디렉토리 구조만 설계하자, 개발자들이 늘상 해왔던 것처럼.

개발 문서화는 왜 하는 걸까?

Medium