개발 시, 반드시 문서화 작업을 해야 하는 이유 -1부
이전 개발에 대한, 문서나 관련 자료가 있을까요?
이전 개발에 대한, 문서나 관련 자료가 있을까요?
파트너사분들과 함께 새로운 작업을 진행하기 위해 미팅을 진행할 때, 대부분의 작업은 신규 개발이긴 하나, 간헐적으로 리뉴얼 개발 혹은 고도화 개발을 요청하시는 경우가 있습니다.
이때, 저희가 가장 먼저 여쭤보는 것은 ‘기존 개발 사항에 대한 문서나 자료가 있을까요?’라는 질문을 먼저 드립니다.
왜 퍼니디어는 [문서화에 대해 질문]을 드릴까요?, 그리고 왜 [문서화가 반드시 필요할까요?]라는 질문에 대해 답변을 드리는 시간을 갖도록 하겠습니다.
원활한 의사소통
퍼니디어 팀에서 개발 진행 시 파트너 사와 가장 중요하게 여기는 것은 ‘의사소통’입니다.
아무리 개발을 잘하고, 기술력이 좋은 회사라도 파트너와 의사소통 능력이 떨어진다면
결국 파트너사가 원하는 서비스가 아닌, 개발사가 개발하기 편하게 작업이 된 서비스가 나오게 됩니다.
특히 고도화 개발의 경우 이미 만들어진 서비스에서 작업을 진행하는 것이므로 처음부터 개발해야 하는 상황보다 더 많은 것을 고려해야 합니다.
어떤 서비스인지, 어떤 기능이 있는지, 기능이 어떻게 동작하는지, 어떠한 구조를 가지고 있는지 등 파악해야 하는 등, 단순 기능 부착이 아닌, 이미 개발된 서비스에서 어떻게 동작해야 할지, 어떤 부분에 영향을 미칠지 등에 대해서도 면밀히 검토가 필요합니다.
만약 문서화된 자료가 없다면, 서비스에 대한 기능을 파악하고 이해하는데 많은 시간이 걸리게 됩니다.
후속 개발 그리고 인수인계를 위한 정확한 기록
모든 서비스는 한 번의 개발로 완성되지 않습니다.
지속적인 고도화, 리뉴얼 작업을 통해 발전해 나가고 안정적인 서비스를 제공하게 됩니다.
이때, 처음 개발을 진행한 업체 혹은 개발자가 모든 과정을 진행하면 좋겠지만, 이러한 경우는 매우 드뭅니다.
대부분은 새로운 개발업체를 통해 개발을 진행하거나, 다른 개발 인력이 이어서 진행할 확률이 높습니다.
이럴 때 후속 업체 혹은 개발자에게 프로젝트에 대한 설명을 할 수 있는 가장 좋은 방법은 ‘문서 자료’입니다.
기억에만 의존한 전달은 모든 내용을 전달할 수 없지만, 문서화된 자료는 모든 정보를 전달할 수 있습니다.
내용이 잘 정리된 문서가 있는 경우, 기존 개발 상황을 파악하는 시간을 줄임과 동시에 빠르게 고도화 방향 등을 설정하는 데 도움을 줄 수 있습니다.
마치며...
오늘은 짧지만, 문서화 작업에 대한 중요성에 대해서 알아보는 시간을 가졌습니다.
위와 같이 문서화는 단순한 기록이 아닌 서비스의 미래의 진행 방향과, 개발 시간과 비용 등에 지대한 영향을 줄만큼 핵심적인 역할을 합니다.
대부분의 경우는 문서를 가지고 계시지만 간헐적으로, 문서를 못 받으신 경우가 있으며, 가끔은 서비스에 대한 개발 소스코드조차 받지 못하신 분들도 계십니다.
이러한 경우에는 개발 범위에 따라 다르지만, 추가하고 싶으신 기능이 많거나, 전체 리뉴얼을 진행하시고자 하는 경우에는 해당 개발을 진행한 업체에 진행을 하시는 경우가 가장 좋으나, 대부분은 이전 개발사와 문제로 인해 새로운 개발사를 찾는 경우이기 때문에 이전 개발사로부터 자료 전달을 받기는 쉽지 않습니다.
더군다나 이런 경우 계약서에 명시되어 있는 경우가 적기 때문에, 더욱이나 힘이 듭니다.
문서가 없다면, 고도화를 진행하거나 서비스에 대해 누군가에게 설명할 상황이 있다면 상대방을 이해시키기가 쉽지 않습니다.
그렇기에 퍼니디어는 문서화 작업에 대해 중요성을 느끼고, 파트너분들께도 강조 드립니다.
그렇다면, 외주 개발 시, 어떤 문서들을 작성해야 하는지, 혹은 어떤 문서를 요구해야 하는지에 궁금하신 분들이 계실 거라고 생각이 됩니다.
다음 2부에서는 개발 시, 어떤 문서들이 있는지에 대해서 알아볼 수 있는 시간을 가져보도록 하겠습니다.
