지난 9월 5일, CODEF API 개발 가이드가 리뉴얼 오픈을 했습니다. CODEF API는 365일, 24시간 무중단으로 제공되는 구독형 API 중개 플랫폼입니다. 개발 가이드에는 400여 개에 이르는 CODEF API 상품에 대한 설명이 모두 등록되어 있죠.

이번 개편은 개발 가이드 최초 오픈 이후 3년 만에 진행된 것이며, 고객의 사용성 증진과 운영의 편의성 향상을 위해 머리부터 발끝까지 모두 바뀌었다는 점에서 굉장히 의의가 큽니다. 시작부터 최종 배포까지, 개발 가이드의 개선된 모습을 위해 누구보다 고군분투했을 기획팀 아연님, API팀 나리님, 보미님, 그리고 디자인팀 유진님을 모시고 개발 가이드 개편 과정을 들어보았습니다.

Q. 안녕하세요. 간단한 자기소개와 개발 가이드 프로젝트에 담당한 업무 소개 부탁드립니다.

아연 : 안녕하세요. UI/UX부 기획팀 김아연입니다. 사업팀, 개발팀의 개편 요구사항을 파악하고 개발 가이드의 메뉴 구조 및 기능, UI 개선에 대한 기획 업무를 담당했습니다.

나리 : 개발1부 API팀 유나리입니다. 개발 가이드 프로젝트에서는 리뉴얼 설계 및 백엔드 파트를 담당했습니다.

보미 : 개발1부 API팀 소속 이보미입니다. 이번 프로젝트에서 프론트 개발 업무를 맡았습니다.

유진 : 안녕하세요. UI/UX부 디자인팀 김유진입니다. 개발 가이드 리뉴얼에서 전반적인 디자인을 담당했습니다.

Q. 개발 가이드 개편에 대한 필요성이 대두된 시점이 언제였고 무엇이 문제였나요?

보미 : 제가 입사했을 때부터 개편에 대한 이야기는 조금씩 나왔던 것 같아요. 대략 1년이 넘었네요.

아연 : 맞아요. 개편이 필요하다는 이야기가 나온 건 한참 전이었어요. CODEF API가 오픈한지 3년이 다 되어가는데 메인 사이트인 CODEF API는 일부 리뉴얼이 되었지만 개발 가이드는 오픈 시점부터 그대로였거든요. 그 기간 동안 고객사가 많이 늘어났고 문제점을 개선할 필요성이 커졌어요.

나리 : 효율적이지 않은 운영 프로세스가 늘 문제였어요. 일관되지 않은 가이드도 문제였고.. 무엇보다 페이지별로 하드코딩을 해야 하니 담당자들 고생이 컸어요. 기회가 될 때 이를 보완하고자 빠르게 개편을 진행하게 되었습니다.

Q. 하드코딩이라면?

아연 : 페이지마다 코드를 새로 짜야 하는 형태라고 이해하시면 돼요.

나리 : 개발 가이드에는 400여 개의 API가 제공되고 있는데, 상품을 등록할 때마다 페이지를 새로 짜야 했던 거죠.

보미 : 게다가 데이터가 어딘가에 정리되어 있던 것도 아니고 소스 안에 박혀있었어요. 페이지 별로 담당자도 달라서 각자의 스타일로 코딩을 했죠.

나리 : 이런 상황이 누적되다 보니 가이드의 내용이 일관되지 않는다는 문제로 이어졌어요.

“외부적으로는 고객 편의성 제공, 내부적으로는 운영 효율성 개선이 필요했어요.”

Q. 개발 가이드 개편에서 가장 중요했던 점이 무엇인가요?

아연 : 개발 가이드에서 제공하는 API가 워낙 많다 보니 고객이 사용하고자 하는 API를 찾기 힘든 상황이었어요. 그래서 검색 기능이 꼭 필요했죠. 그리고 API 문서의 상세 내용을 읽기 편하게 개선하는 것도 중요했어요. 이에 방향성을 맞춘 기획을 많이 고민했습니다.

나리 : 외부적으로는 고객을 위해 CODEF API 사용 편의성을 제공하는 게 중요했다면, 내부적으로는 개발 가이드 운영 효율성 개선이 가장 큰 목표였어요. 특히 개발 가이드를 등록하고 업데이트하는 것에 대해서 말이죠.

보미 : 맞아요. 내부적인 운영 개선이 정말 중요한 상황이었습니다. 기존 개발 가이드에서는 앞서 얘기한 것처럼 상품 하나가 등록되고 수정될 때마다 하드코딩으로 작업을 했거든요. 개발자스럽지 못한 작업에 투입되는 시간이 늘 고통이었습니다..🥲 그래서 기존 개발 가이드의 하드코딩을 제거하고 데이터들을 DB화하는 것이 중요했습니다.

유진 : 저는 디자인 파트를 담당하다 보니 높은 가독성과 일관된 스타일에 초점을 맞췄어요. 기존 개발 가이드 화면의 흐릿한 배경색을 없애고, 제목과 본문의 폰트 스타일을 명확하게 구분했습니다. 그리고 개발 가이드는 여러 개발자가 직접 작성하는 문서 개념의 사이트여서 통일된 작성을 위한 가이드에도 집중했죠.

Q. 프로젝트 중 가장 보람을 느꼈던 순간은 언제인가요?

나리 : 모든 개발 가이드 데이터가 DB화 되었을때 가장 큰 보람을 느꼈습니다.

보미 : 제 의견이 받아들여져 가이드에 반영되었을 때 보람을 느꼈어요. 상품 가이드 부분의 in/out 파라미터들을 기존에는 여러 테이블로 쪼개 표현했었는데 이번에는 하나의 테이블로 만들어보자고 의견을 냈었거든요.

아연 : 저는 개발 가이드 개편 기획을 맡은 것 자체가 보람이었어요. 최초 개발 가이드 오픈을 위한 기획도 제가 작업했었는데, 이번 프로젝트에서 부족했던 부분들을 직접 보완할 수 있어서 더 좋았습니다.

유진 : 한눈에 보기에도 사이트가 확 바뀌었다는 것을 느꼈을 때 좋았죠. 흐릿한 배경을 없애고 밝고 깨끗한 느낌으로 바꾸려고 노력했는데, 이게 잘 구현된 것 같아요.

보미 : 맞아요. 화사해져서 너무 보기 좋아요! 계속 보고 또 보고 싶은 느낌이에요. 어제도 집에 가서 다시 봤어요😆

01_development_guide

Q. DB화, 얼마나 힘든 작업이었나요?

보미 : 우리 상품 개수로 얘기하는 게 낫지 않을까요?

아연 : 400여 개의 상품을 다 DB화 해야 해서 힘들었죠. DB화 작업을 좀 더 자세히 설명하자면, 기존에는 페이지 별로 코딩이 되어 있었다고 했잖아요? 이것을 정리하기 위해 공통 폼을 만들고, 그 폼에 맞게 데이터를 일일이 넣는 작업이었어요.

보미 : 한 상품에 짧으면 10분, 길면 1시간까지 걸렸죠...

나리 : 게다가 각 페이지의 데이터도 각각 수집해야 했으니, 상당히 오래 걸리고 눈이 아픈 작업이었어요🥲

“아예 처음으로 돌아간다면 고생을 덜하지 않았을까..”

Q. 개발 가이드 프로젝트 시작 시점으로 돌아간다면 바꾸고 싶은 게 있나요?

보미 : 시작 시점으로 다시 돌아가야 하나요..? 전 돌아가고 싶지 않습니다. 지금은 정말 뿌듯하다고 말할 수 있지만, 고생했던 순간으로 돌아가고 싶진 않네요😂

나리 : 음.. 저는 돌아갈 수 있다면 개발 가이드 프로젝트 맨 처음, 1.0 ver으로 돌아가고 싶어요. 운영 부분을 이렇게 안 만들었다면 좀 더 빨리 개편할 수 있었고, 모두들 지금까지 고생을 덜 하지 않았을까 싶어서요😇

아연 : 전 딱히 바꾸고 싶은 게 없습니다! 지금의 개편된 개발 가이드에 만족하고 있어요!

유진 : 가능하다면 코드에프의 모든 사이트에 일관된 디자인 시스템을 구축할 수 있었다면 좋았을 것 같아요. 코드에프 ABOUT, API 메인, 개발 가이드까지 모두 다요!

02

Q. 솔직히 이건 내가 고생했다 하는 것 시원하게 쏟아냅시다.

유진 : 디자인 시안과 구현된 화면의 차이를 잡아내는 QA에 시간과 정성을 많이 쏟았어요. 제가 디자인을 다 잡고 가다 보니 미묘한 차이가 눈에 잘 들어오기도 했고, 디자인은 워낙 요소가 자잘해서 자세히 봐야 했거든요.

나리 : 흩어져 있던 데이터를 수집하는데 많은 시간을 쏟아야 했습니다. 저뿐만 아니라 API팀 모두가 많은 고생을 했죠. 모두가 눈이 빠지게 데이터를 확인 또 확인했던 것 같습니다.

아연 : 제가 더 고생했다 하는 건 없어요. 모두들 고생하셨습니다~

보미 : 맞아요. 진짜 모두들 고생하셨습니다. 저도 특별히 제가 더 고생한 건 없다고 생각합니다.

Q. 개편된 개발 가이드의 특장점을 소개해주세요.

나리 : 디자인이 깔끔하게 바뀌었고 가독성을 높여서 사용자의 편의성이 개선되었습니다. 내부적으로 모든 데이터가 DB화 되었고 개발팀 운영의 효율성도 높아졌습니다.

보미 : 사용자 입장에서 보는 화면이 화사해지고 메뉴 구조도 깔끔해졌습니다. 개발자 입장에서는 가이드 등록/수정이 편해졌습니다.

아연 : 400여 개의 API 중 원하는 API를 쉽게 찾을 수 있고, 이전에 없던 API 검색 기능이 추가되었습니다. 모바일 화면도 개선되어서 PC뿐만 아니라 모바일 환경에서도 편하게 볼 수 있어요.

03_search

“우리 서비스는 진짜 친절해요. 그것만큼은 확실합니다.”

아연 : 그리고 무엇보다 CODEF API 개발 가이드는 진짜 친절해요. 다른 서비스들은 보통 in/out만 보여주고 끝나거든요. 저희는 부가적인 설명도 다 정리되어 있어요.

또, 타사 서비스들은 사이트에 설명이 있다기보단 문서를 내려받을 수 있는 형태인데, 개편된 우리 개발 가이드는 페이지로도 볼 수 있고, 문서도 엑셀이나 PDF 두 가지로 바로 내려받을 수 있죠.

API 상품이 많은 것에 비해 하나하나 친절하게 설명되어 있어서 고객들이 사용하기 훨씬 편리할 거예요.

Q. 개발 가이드를 이용하는 고객사에 한마디 한다면?

아연 : 더 나은 서비스를 제공하기 위해 코드에프의 모든 구성원들이 많이 노력하고 있습니다.

나리 : CODEF API를 좀 더 편리하게 사용할 수 있도록 개발 가이드를 개선했으니까요, 많이 사용해 주시기 바랍니다. 그리고 API 개발에 문의사항이 있으시면 언제든지 코드에프 홈페이지 Q&A로 문의해 주세요. 개발팀이 아주 친절하게 안내드립니다🤗

보미 : 새로 생긴 엑셀 다운로드 기능도 많이 이용해 주세요!

Q. 마지막으로 함께한 동료들에게 한 마디 해주세요.

유진 : 벤치마킹부터 최종 시안 작업까지 지속적으로 의견 주고받고 논의하는 과정이 흥미롭고 좋았습니다. 디테일한 요구도 잘 들어주셔서 감사했습니다. 모두들 고생하셨습니다🥹

아연 : 고생하셨습니다~👏👏👏 앞으로도 다른 프로젝트에서 같이 하게 되면 잘해보아요.

보미 : 함께해서 행복했습니다.

나리 : 개발1부 API팀 BE1파트 승경님,수빈님 FE파트 봄님,다솜님,지은님 그리고 UI/UX부 아연님, 유진님 모두 고생 많으셨어요❤️ 그리고…운영업무 개선 및 고객의 편의성을 빠르게 제공하고자 일정 압박을 조금 주신 오세용 부서장님도 마음고생 많으셨습니다!!

--------------_-----------_01

평소보다 담을 내용이 많았던 오늘의 인터뷰! 메인 담당자들은 만나 이야기를 들어보니 개발 가이드 개편 과정이 얼마나 고된 작업이었는지, 그리고 얼마나 많은 것들이 바뀌었는지 확실히 알 수 있는 시간이었습니다. 새롭게 단장한 개발 가이드가 궁금하신가요? 여러분의 비즈니스를 위한 데이터 연결을 도울 개발 가이드를 아래 배너를 통해 자세히 살펴보세요.😊

01_----------------_220914

본 페이지 내의 모든 콘텐츠는 저작권법에 의해 보호받는 저작물로서, 모든 사용 권리는 ㈜코드에프에게 있습니다. 별도의 저작권 표시 없이 무단으로 사용하는 것을 금지하며, 자세한 저작권 정책은 해당 링크를 참고하시기 바랍니다. Copyright 2022.㈜코드에프 All rights reserved.

코드에프의 문화가 궁금하신가요?
아래 인터뷰들을 확인하여 코드에프가 일하는 모습을 확인해보세요.

[코드에프 팀터뷰 #6] 경영지원실을 소개합니다
‌[코드에프 인(人)터뷰 #4] 준법감시실 오수현님을 소개합니다
[코드에프 팀터뷰 #5] 코드에프 인프라팀을 소개합니다들인 (2)
[코드에프 팀터뷰 #4]코드에프 마이데이터팀을 소개합니다
[코드에프 팀터뷰 #3]코드에프 디자인랩 기획팀을 소개합니다
[코드에프 팀터뷰 #2]코드에프 데이터랩 API 백엔드 개발팀을 소개합니다
[코드에프 팀터뷰 #1]사업팀을 소개합니다
[코드에프 (人)터뷰 #1]디자인팀 김유진