language를 거지같이 구사하는 경우들은 위의 sonarqube가 아주 혼쭐을 내주니까 그걸로 해결보시면 되고.
새 개발자가 와서 로직을 즉시 이해하지 못하는 경우는 use case 문서화가 잘 안 되어 있으면 그렇습니다. use case는 business feature 고수준에서 utility method 같은 아주 작은 단위까지 정의할 수 있는데, 보통은 문서를 만들지 않고 말로 협의하고 코딩해서 커밋하고 땡 치죠. 이건 개발자들의 오랜 dna 입니다, 아무리 강조해도 결국은 다 말로 하고 문서는 안 남고 남기더라도 차후 갱신하지 않아 문서가 죽습니다. 그래서 다음 개발자 교육을 위한 문서화 강조 및 시행은 정답이 아닙니다.
이 use case 문서화는 unit test를 통해서 하시는 게 효과적입니다 (이 싯점에서 TDD 검색). unit test는 두 가지 목적으로 사용하는데 첫번째는 코드 변경 때마다 주요 happy case와 negative case들이 여전히 잘 작동하고 있다는 것을 확인하기 위해서 쓰고 (regression test라 부릅니다), 두번째는 코드가 얼마나 잘 테스트 되었는지를 측정하기 위해서 씁니다 (line coverage test라 부릅니다).
그래서 팀에 두 가지 규칙을 더 도입하면 개발자 간 use case 교육의 문제들도 거의 해결됩니다. 1) 코드 커밋 시 모든 작성된 unit tests가 성공할 것. 2) unit tests를 돌릴 경우 line coverage 80% 이상으로 만들 것.
내가 있던 예전 팀의 경우 java, javascript 둘 다 80% 안 되면 integration server로 모듈 deploy가 안 되도록 system rule을 걸어 놓았음. 처음에는 80% 너무 높다고 생각했는데 쪼니까 다 됨. 새 개발자가 와도 본래 개발자한테 묻지 않고도 unit test 죽 돌려보면 주요 기능 파악이 하루 이내에 다 끝남.
처음에는 line coverage 30% 정도를 목표로 해서 로직의 entry point를 전부 커버하는 정도로 하면 regression test 및 유사시 다른 개발자 교육용으로 충분할테고, 이 과정이 익숙해지면 점차 목표 %를 올려서 exception 같은 것까지 테스트 하는 negative case를 계속 추가해서 80%를 향해서 가면 됨.