클라우드 플랫폼 사용가이드의 혁신: 기술에서 사용자중심으로
기술 중심의 클라우드 플랫폼 가이드를 사용자 중심의 정보로 전환시켰습니다.
프로젝트 개요
Amazon Web Services (AWS)나 Microsoft Azure는 많은 이들에게 친숙한 클라우드 플랫폼입니다. 한국은 전 세계에서 인터넷 속도가 가장 빠른 나라 중 하나이며 인터넷 사용률도 매우 높습니다. 이러한 환경은 클라우드 서비스의 발전과 채택에 매우 유리하죠.
한국의 클라우드 서비스 시장의 대표 주자는 네이버 클라우드 플랫폼입니다. 네이버는 한국의 선도적인 인터넷 기업으로, 강력한 검색 엔진, 다양한 온라인 서비스 및 클라우드 플랫폼을 제공하고 있습니다.
2021년, 네이버는 한샘글로벌에 네이버 클라우드 플랫폼의 사용 가이드 개선 작업을 의뢰했습니다. 당시 네이버 클라우드 플랫폼에서 다양한 형태로 제공 중이던 200여개 기능의 사용 가이드는 형식이 일정하지 않았고 기술 개발자가 작성한 어려운 용어와 모호한 설명이 상당했습니다. 주요 기능의 사용법 문의에 고객 대응 업무에 많은 리소스를 투입하고 있던 네이버 클라우드는 사용자 친화적인 가이드를 개발하기로 결정했고, 이런 작업에 적합한 역량을 갖춘 기업인 한샘글로벌에게 협력을 제안했던 것입니다.
도전 과제
기술적 지식
클라우드 컴퓨팅에 대한 기본적인 이해를 바탕으로 네이버 클라우드 플랫폼의 구체적 기능, 도구 및 관리 인터페이스에 대한 심층적인 이해가 필요했습니다. 소비자용 전자제품에 익숙한 한샘글로벌의 테크니컬 라이터 그룹은 네이버 사용가이드를 작성하기 위해 클라우드 플랫폼이 가진 복잡하고 전문적인 기술 지식에 대한 이해가 선결 과제로 부상했습니다.
사용자 경험에 대한 이해
유용한 사용자 가이드를 만들려면 실사용자에 대한 이해가 필수적입니다. 우리는 다양한 사용자 그룹 (예: 개발자, 시스템 관리자, 플랫폼서비스 사용자)의 요구와 경험을 이해하고 그들이 가진 니즈를 충족시켜 줄 수 있는 내용을 만들어 내어야 했습니다.
체계적이고 일관성 있는 문서화
기존의 클라우드 플랫폼에서 다양한 형태로 제공 중이었던 200여개 상품과 기능의 사용 가이드는 일정한 형식 없이 작성되어 있었습니다. 문서화에 대한 체계적인 가이드라인없이 여러 부서의 여러 개발자가 개별적인 방식으로 작성했던 기존 가이드는 상품마다 서비스마다 서로 형식으로 구조로 제공되고 있었습니다. 또한 사용자가 필요한 정보를 검색해서 활용하기 어려운 구조로 되어 있었기 때문에 이를 어떤 식으로 체계화시켜야 할지가 과제였습니다.
장기 프로젝트
이 프로젝트는 100개 이상의 기존 가이드를 갱신해야 하므로, 매월 단위로 새로운 가이드를 선정해서 진행하는 방식이어서 장기간 작업이 예상되는 프로젝트였습니다. 그래서 지속성있는 작업팀과 지속될 수 있는 작업 방식을 구현해야 했습니다.
한샘글로벌의 대응
장기간 대응할 수 있는 전담팀의 구성
한샘글로벌의 테크니컬라이터 중에서 기술적인 이해가 빠르고 유사 작업에 투입한 경험이 있는 라이터들을 이 프로젝트에 전담으로 배정했습니다. 그리고 20년 이상의 경력을 가진 시니어 테크니컬 라이터를 프로젝트 리더로 배정했습니다.
기술적 배경 학습과 사용 경험 학습
이 프로젝트에 배정된 테크니컬 라이터들은 클라우드 플랫폼에 대한 방대한 리서치를 통해 배경 지식을 확보했습니다. 그리고 고객사의 개발자 미팅, 외부 교육 수강 등 다양한 방법을 적극적으로 활용해 필요한 정보를 습득했습니다.
사용자 경험 학습을 위해 네이버 클라우드 플랫폼에 접속해 개별 기능을 꼼꼼하게 확인하는 한편, 기능 설명을 돕기 위한 간단한 코딩 예제 등을 직접 테스트하면서 일정에 따라 차근차근 개정 작업을 진행했습니다.
이런 과정을 통해서도 필요한 정보를 얻을 수 없는 경우에는 문의 사항을 상세하게 정리해 고객에게 전달했으며, 필요한 경우 개발자와의 화상 미팅을 통해 추가 정보를 습득하고 문제를 해결했습니다.
명확한 목표 수립
목표가 명확해야 작업의 범위가 구체화되고 작업 절차를 표준화시키고 일관성 있는 방식으로 대응이 가능해집니다. 우리는 고객 측에서 제시한 주요 개선 요청 사항과 작업 방식을 면밀하게 점검했고 기존 가이드의 현황, 고객이 필요로 하는 것, 유사 서비스의 동향 등을 분석하여 이번 작업의 목표를 다음과 같이 정했습니다.
- 모든 사용 가이드의 구조를 체계화시킨다
- 일관성있게 적용한다
- 검색성을 높이고 사용자 이해도를 높인다
검색성, 가독성과 사용성 향상
목차는 사용자가 쉽게 이해하고 따를 수 있는 사용 정보로 바꾸었습니다. 사용자에게 필요한 정보만 선별하고 분류한 뒤 낯선 개념은 별도의 공간에서 충분히 설명하고, 사용 목적과 직접적인 연관이 없거나 모두가 알 만한 내용은 적절히 생략했습니다.
검색성을 높일 수 있도록 사용자 목적과 행동 중심으로 목차를 재편했고 이렇게 선별된 토픽들로 목차 구성을 표준화시켰습니다. 목차 구조는 모든 문서에 일관성 있게 적용될 수 있도록 기준을 수립했습니다.
가독성과 사용성을 높일 수 있도록 가이드에 적용한 문장스타일과 그래픽이나 일러스트, 도표 등의 시각적 도구의 형식도 표준화시켰습니다. 문장 스타일은 짧고 간결하게, 간단 명료하게 정보를 전달하고, 표나 이미지를 활용해 복잡한 정보를 이해하기 쉽도록 정리하여 정보의 직관적 이해도를 높일 수 있고 전체 문서에 일관되게 적용되도록 했습니다.
고객과의 협업 작업 도구 개발
초안 작성, 고객 피드백, 협의 및 적용 등에 따른 일련의 제작 과정에서 고객과 협업을 용이하게 전개할 수 있도록, 적절한 HTML 문서 작성 애플리케이션과 마크다운 작업 도구를 채용하여 협업을 위한 최적의 작업 환경을 구현했습니다.
결과
이 프로젝트는 2년이상 진행되었습니다. 이 기간 동안, 한샘글로벌은 매월 예외없이 계획된 개발 목표를 달성하며 고객 상품의 사용 가이드를 개선해 왔으며, 고객은 결과에 대해 만족했습니다. 가이드는 체계적이고 일관성있게 개선되었고 사용법에 대한 문의는 현저하게 줄어 들었습니다.
클라우드 플랫폼 사용가이드라는 기술집약적인 설명서 개선작업을 성공시킨 한샘글로벌의 콘텐츠 개발팀은 네이버의 플랫폼 가이드 외에도 기업의 업무 자동화 솔루션, 개발자를 지원할 수 있는 API 문서 개선작업으로 범위를 넓혀가고 있습니다. 기술적인 문서를 사용자친화적인 문서로 혁신해 가려면 한샘글로벌의 콘텐츠개발팀에 문의해 주세요.