LINE Planet 문서 사이트 개선 안내
안녕하세요, LINE Planet 프로젝트에서 테크니컬 라이터로 일하고 있는 하성창입니다. 올해 초에 LINE Planet 문서 사이트를 새롭게 선보이면서 더 나은 구성 및 UI를 제공하는 것뿐만 아니라 기존에 영어만 지원하던 것을 영어와 한국어 두 가지 언어를 지원하도록 한 바 있는데요. 이후에도 저희는 한층 더 나은 사용자 경험을 제공하고자 꾸준히 노력해 왔습니다.
여기서는 최근 PlanetKit 5.2 및 WebPlanetKit 5.2의 릴리스에 이르기까지 LINE Planet 문서 사이트에 적용된 개선 사항을 공유해 드리고자 합니다. 개선의 핵심 측면인 정보 아키텍처 개선, 개발자 경험 향상, 검색 기능 최적화를 중심으로 설명드리겠습니다.
정보 아키텍처 개선
기존에는 클라이언트 개발자를 위한 콘텐츠와 서버 개발자를 위한 콘텐츠의 영역 구분이 명확하지 않아서 사용자가 원하는 정보를 찾는 데 어려움이 있었습니다. 이러한 문제를 해결하고 문서 사이트의 구조를 보다 직관적으로 만들기 위해, 아래처럼 사용자 유형별 워크플로에 맞춰 콘텐츠를 재구성하고 관련 주제를 그룹화했습니다.
문서 사이트의 상위 수준 구조는 이제 다음과 같습니다.
| 최상위 카테고리 | 설명 | 문서 버전 구분 |
|---|---|---|
| 개요 | LINE Planet의 주요 특징, 전체 기능 목록, 주요 용어 정의 등을 포함한 개요를 제공합니다. | 버전 구분 없음* |
| 시작하기 | LINE Planet 연동 과정을 시작하는 데 도움을 주는 영역으로, 개발 환경 설정, 샘플 애플리케이션 클라이언트 및 서버 사용을 다룹니다. | 버전 구분 없음 |
| SDK | 애플리케이션 클라이언트를 직접 구현하기 위한 가이드와 참조 문서를 클라이언트 플랫폼별로 구분하여 제공합니다(Android, iOS/macOS, Windows, Web). | 플랫폼마다 SDK 버전별 문서 제공 |
| 서버 API | 서버 측 연동을 위한 가이드 및 참조 문서를 제공합니다. | 버전 구분 없음 |
| 도움받기 | 자주 묻는 질문에 대한 답변, 트러블슈팅 자료, 연락처 정보 등 일반적인 문제를 해결하기 위한 리소스를 제공합니다. | 버전 구분 없음 |
* 버전 구분이 없는 영역의 문서에서는 최신 정보만 제공합니다.
개발자 경험 향상
이전에는 모든 플랫폼에 대해 공통 문서 세트를 제공했으며, 여러 플랫폼에서 동일한 기능을 하는 API를 나타내는 데 공통 키워드를 사용했습니다. 예를 들어, 실제 API 네이밍 패턴은 플랫폼마다 다르지만, 모든 플랫폼에 대한 이벤트 콜백을 표현하고자 키워드 'evt*'(예: evtConnected 및 evtDisconnected)를 사용했습니다. 이러한 문서 작성 방식 때문에 API 레퍼런스나 코드와 함께 문서를 보고 이해하는 데 어려움이 있었습니다.
이 문제를 해결하고자 다음처럼 개발자 경험을 보다 효율화하기 위한 작업을 진행했습니다.
- 플랫폼 및 버전별로 문서 분할
- 'SDK' 카테고리의 문서를 클라이언트 플랫폼별로 분할했습니다.
- 각 클라이언트 플랫폼 문서의 버전은 해당 플랫폼 SDK의 릴리스 버전에 해당합니다.
- 실제 API를 반영하도록 문서 업데이트
- 실제 API 이름을 반영하도록 문서 전반적으로 설명과 다이어그램을 업데이트했습니다.
- 참고: 이 변경 사항은 PlanetKit 5.2 및 WebPlanetKit 5.2 문서부터 적용됩니다.
- 더 많은 코드 샘플 제공
- 이제 플랫폼 및 버전별로 문서가 제공되므로 해당 플랫폼 및 버전에 대한 코드 샘플을 추가할 수 있게 되었습니다.
- 이는 계속 진행 중인 작업으로, 고객사에서 서비스를 구현할 때 도움이 되도록 코드 샘플을 계속 추가할 예정입니다.
아래 그림처럼 왼쪽 사이드바 드롭다운 메뉴에서 클라이언트 플랫폼과 SDK 버전을 선택할 수 있습니다.
검색 기능 최적화
클라이언트측 구현을 위한 문서가 플랫폼별, 버전별로 제공되면서 콘텐츠의 양도 늘어났습니다. 따라서 기존처럼 모든 문서에 대해 특정 키워드를 검색한 결과를 표시한다면 검색 결과가 너무 많아서 필요한 정보를 찾는 것이 어려울 가능성이 있습니다.
이 문제를 해결하고자 다음처럼 상황에 맞는 방식으로 검색이 작동하도록 했습니다. (두 경우 모두 현재 선택된 언어를 대상으로 검색이 수행됩니다.)
- 'SDK' 카테고리 문서를 보는 상태에서 검색하면 나머지 카테고리 전체와 'SDK' 카테고리 중 현재 플랫폼 및 버전의 문서만을 대상으로 검색이 수행됩니다.
- 'SDK' 이외 카테고리 문서를 보는 상태에서 검색하면 문서 전체를 대상으로 검색이 수행됩니다.
이처럼 상황에 맞는 검색 기능을 통해 필요한 정보를 더 쉽고 효율적으로 찾을 수 있을 것으로 기대합니다.
참고로 검색 기능의 이용 방법은 다음과 같습니다. 먼저 우측 상단 검색창에서 검색어를 입력하면 검색 결과가 표시됩니다.
더 많은 검색 결과를 보려면 아래로 스크롤하여 하단의 '검색 결과 모두 보기'를 클릭합니다.
이렇게 하면 전체 검색 결과를 보여주는 페이지가 나타나며, 스크롤하여 더 많은 검색 결과를 확인할 수 있습니다. 또한 아래 표시한 부분의 드롭다운 메뉴에서 검색하고자 하는 클라이언트 플랫폼 문서의 버전을 선택하여 새로 검색할 수도 있습니다.
맺음말
지금까지 LINE Planet 문서 사이트에 적용된 개선 사항을 소개해 드렸습니다. 위에서 설명드린 세 가지 측면에 초점을 맞춤으로써 사이트의 전반적인 유용성이 크게 향상되었다고 생각합니다. 앞으로는 신규 사용자를 위한 온보딩 콘텐츠를 더 많이 추가하고 LINE Planet을 더 효율적으로 활용할 수 있도록 코드 예제를 확장하는 등 추가 개선을 위해 노력할 것입니다.