- 코드 암묵지(보이지 않지만 지켜야 할 규칙)는 신규 입사자 온보딩 및 AI 활용에 필수적인 정보입니다. 💡
- 회사의 규모와 문화에 따라 전사적 문서화 또는 팀 단위 문서화 전략을 선택해야 합니다. 🏢
- 전사적 영향력이 가능하다면, 메인 Git 리포지토리에
convention 프로젝트를 만들어 소프트웨어 컨벤션 및 정책을 상세히 기록합니다. 📁
- 신규 서버 개발자들을 대상으로 정기적인 세션을 열어 문서 내용을 공유하고, 회사 상황에 맞는 선택 이유를 설명합니다. 🧑🏫
- 온보딩 세션은 신규 입사자가 코드와 회사 상황을 어느 정도 이해한 후에 진행하는 것이 효과적입니다. ⏳
- 대부분의 회사에서는 팀 단위로 프로젝트 Git 리포지토리에
convention.md 파일을 추가하여 팀 고유의 의사결정 및 규칙을 문서화하는 것이 현실적입니다. 📄
- 팀 내부의 협의 결정은 전사 컨벤션보다 우선할 수 있으며, 이러한 오버라이드 사항을 명확히 기록해야 합니다. 🤝
- 모든 프로젝트를 완벽하게 문서화할 필요는 없으며, 핵심 프로젝트에 집중하고, 유지보수 모드인 프로젝트는 그 상태를 명시하는 것도 방법입니다. 🚧
- 암묵지 문서화는 핵심 인력의 갑작스러운 퇴사 시 발생할 수 있는 혼란을 방지하고, 신규 입사자의 빠른 적응을 돕습니다. 🚀
- 잘 정리된 암묵지는 AI 에이전트가 프로젝트의 의도와 컨벤션에 맞춰 더 정확하고 유용한 결과물을 생성하도록 돕습니다. 🤖
- 소프트웨어 개발은 정답이 하나가 아닌 협력적이고 진화하는 과정이며, 문서화는 이러한 재미를 더하는 요소입니다. 🧩
- 가장 이상적인 전략은 느슨한 전사 컨벤션을 마련하고, 각 팀이 이를 커스터마이징하여 문서화할 수 있도록 유연성을 제공하는 것입니다. 🌐
데브허브 | DEVHUB | 코드 암묵지 문서화 전략