개발자로서 일을 하다 보면 종종 다른 사람과 협업 시 결과물을 만들 때 세세한 마감이나 디테일을 놓칠 때가 있다.
마음에 마감에 대한 조급함이 있고 개발 완료하느라 지쳐 있을 때 더욱 이렇게 된다.
예를 들자면 백엔드 개발자로서 API를 개발한 후에 API 문서에 대해 작성하는 것을 놓칠 때가 있다.
API를 개발하느라 이미 진이 다 빠져버려서 프론트 개발자가 디테일한 부분은 알아서 API에 대해서 테스트를 해보고 써줬으면 하는 마음이 들 때가 있는 게 사실이다.
이럴 때 조금만 여유를 가지고 API 문서를 만들면 어떨까?
여기까지 문서로 설명을 해야 하나 싶은 마음이 들 때면 프론트 개발자를 고객으로 생각해보자.
고객에서 API를 전달하는 생산자의 마음을 잠시나마 가진다면 문서를 작성하는 데에 조금이나마 덜 힘들지 않을까 싶다.
API 문서를 작성할 때도 최대한 심플하게 작성하기 보다는 예시까지 구체적으로 작성해주면 더 좋겠다.
나는 요즘 API 문서는 노션에 주로 작성하는 편이다. 접근성이 좋고 누구나 수정할 수 있기 때문이다.
그리고 테스트해볼 수 있도록 postman 같은 곳에 미리 요청을 저장해둔다.
간단히 Send 버튼만 누르면 테스트해볼 수 있게 말이다.
Swagger 같은 API 문서화 도구를 이용해서 설정이 되어 있으면 더욱 좋다.
이런 부분은 다른 개발자들과 협업을 할 때 언제나 기대하게 되는 부분이다.
지금 조금 귀찮더라도 협업하는 사람들에게 친절한 것. 사소한 것이지만 먼저 챙겨서 불편함을 덜하게 하는 것. 이런 부분이 다른 협업하는 사람들을 감동시킬 수 있다.
요즘 함께 일하는 팀 동료들에게서 이런 배려들을 매우 자주 보게 되어 꽤 자주 놀라고 또 감동받고 있다.
상대에 대해 배려하고 친절한 것. 팀으로서 일할 때 큰 힘이 되는 부분이다.