Swift-DocC 콘텐츠의 검색 가능성 향상

♪ 부드러운 힙합 반주 ♪ ♪ 안녕하세요, 휴먼 인터페이스 디자이너 Bea예요 문서 팀 소속이랍니다 이제 Swift-DocC 콘텐츠 검색을 어떻게 개선할지 알려 드릴게요 이 세션에선 새로운 Swift-DocC의 웹 탐색 경험을 다뤄 볼 거예요 그리고 콘텐츠 검색을 최적화하는 팁도 알려 드릴게요 Swift-DocC가 무엇이고 프레임워크와 앱에서 좋은 문서를 어떻게 만들지 추가적으로 알고 싶으시다면 WWDC의 다른 세션을 확인하세요

자, 이제 새로운 웹 탐색으로 넘어가 살펴볼게요 올해 문서 사이트를 발행한다면 여러분의 콘텐츠를 가장 돋보이게 할 새로운 탐색법이 있죠 이 페이지엔 두 가지 주요 부분이 있어요 왼쪽에 있는 탐색기와 필터 바를 쓰면 여러분의 문서를 둘러보면서 API를 빨리 찾을 수 있답니다 오른쪽엔 콘텐츠 뷰가 있는데 다중 화면과 탐색기 크기에 탄력적으로 최적화돼 있죠 탐색기가 콘텐츠와 분리되니까 페이지를 빠르게 전환하기 쉬워요 그리고 공개 표식을 써서 더 깊이 파고들며 API 계층을 이해할 수 있습니다 다 문서를 살펴보기 쉽게 해 주는 기능이랍니다 한편 여러분이 찾는 걸 알고 최대한 빨리 거기 가고 싶다면 필터 바를 써서 탐색 결과를 개선할 수 있어요 그럼 이 필터 작업을 살펴볼게요 여러분이 '서식지'를 찾는다고 치고 필터 바를 클릭해서 입력하면 필터링된 페이지 뷰가 나와요 지금 실제로 관심을 가지는 내용이죠 탐색기를 리셋하면 필터를 비울 수 있어요 글과 튜토리얼도 필터링해 볼 수 있고 태그를 선택해 지원 중단된 페이지도 가릴 수 있죠 예를 들어 튜토리얼 태그를 선택하면 '슬로스크리에이터 소개' 튜토리얼을 굉장히 편리하게 찾을 수 있어요 이제 새로운 탐색 기능을 파악하셨으니 어떻게 이 새로운 경험을 최대한 활용할지 알려 드리죠 개발자들이 원하는 페이지를 최대한 순조롭게 찾을 수 있게끔 여러분 콘텐츠를 최적화하는 팁과 요령이 있어요 제가 프레임워크용 문서인 슬로스크리에이터를 어떻게 최적화하는지 예시로 보여 드릴게요 슬로스크리에이터로 나무늘보를 분류해 녀석을 찾아 사랑스러운 가상의 새 나무늘보를 만들어요 제 프레임워크 문서 작업을 막 끝내서 마크다운 문법을 써서 아직 제 페이지를 구성하진 않았죠 Swift-DocC의 자동 구성을 활용하는 방식으로 시작해 볼게요 제 탐색기를 유형별로 구성한다는 의미죠 튜토리얼이나 글, 프로토콜 그리고 구조 같은 거예요 시작부터 잘되긴 하지만 제 문서를 개발자에게 더 잘 안내할 수도 있어요 제 콘텐츠를 최적화하려면 세 단계를 거쳐요

우선 이 프레임워크로 제가 할 수 있는 주요 고급 테마를 정의해요 그리고 중요도와 특수성에 따라 제 페이지를 정리해요 마지막으로 제 그룹 제목을 최적화합니다 최대한 명확하고 유용하게 말이에요 전 이 과정이 지도를 만드는 것 같다고 봐요 지역의 경계와 일반적인 특성을 사람들이 파악하게 도와주니까요 한 곳에서 다른 곳으로 가는 방법도 알려 주고요 문서 탐색기 역시 개발자가 API 세트로 뭘 할 수 있는지 이해하게 도와줘요 개발자가 찾는 페이지를 어떻게 둘러볼지도요 슬로스크리에이터의 주요 고급 테마를 정의해 개발자가 제 API로 뭘 할 수 있는지 파악하게 돕는 일부터 시작할게요 슬로스크리에이터 페이지 탐색기에 이런 테마가 나타나요 제 문서의 톱 레벨 페이지입니다 개발자가 제 문서 웹사이트에 접속하면 처음으로 보는 것 가운데 하나예요 저한테는 좋은 첫인상을 선사할 기회죠 이 프레임워크가 뭘 하는지 개발자가 피악하는 데도 도움이 되고요 이제 첫 번째 제 테마를 생각해 보죠 슬로스크리에이터의 주요 기능 중 하나는 나무늘보 만들기예요 이름과 색뿐 아니라 특별한 힘까지 있답니다 요약해서 이 토픽 그룹을 '나무늘보 창작'이라 부르죠 이 그룹을 어디 넣을지 나중에 결정하게 일단 플레이스 홀더로 놔둘게요 나무늘보를 만들고 나면 앱 화면이나 지도 뷰 같은 다양한 방식으로 녀석을 그려 볼 수 있죠 전 이걸 '나무늘보 뷰'라고 부르겠어요 나무늘보가 생기면 당연히 할 일이 많아요 먹이고 즐겁게 해 주며 돌봐야 하니까요 전 이런 걸 '관리'라고 부를래요 이 세 가지 그룹에서 벌써 쓸 수 있는 기능이 많죠 슬로스크리에이터를 처음 써 보는 개발자 입장이 돼 보면 이 프레임워크를 어떻게 시작하는지 쉽게 볼 수 있으면 좋겠어요 전 이 점을 염두에 두고 고급 소개 콘텐츠를 담은 토픽 그룹을 만들겠어요 그리고 '요점'이라고 부르죠 잘됐네요 슬로스크리에이터로 할 수 있는 일은 많지만 제가 중점을 두는 건 가장 중요하고 포괄적인 네 가지 토픽 그룹이에요 가능한 옵션의 수를 줄여서 개발자가 성공적으로 다음 단계로 나아갈 가능성을 높이고 있죠 토픽 그룹을 몇 개나 만들어야 이상적인지는 정해져 있지 않으니 보통 전 페이지당 열 개 이하로 제한하려고 해요 지도란 개념으로 돌아가서 개발자가 다음에 갈 수 있는 곳을 단계적으로 안내하고 싶어요 제 그룹 순서는 훌륭한 경험 창출에 핵심적인 요소예요 제 토픽 그룹을 다시 보면 대부분 잘 정리돼 있어요 우선 나무늘보를 만들고서 녀석을 그려 보고 관리할 수 있어요 지금 여기서 바꿀 건 하나죠 요점 칸을 목록의 맨 위로 옮길게요 개발자가 입문 콘텐츠부터 보게요 이젠 이런 각각의 카테고리 아래 정리할 페이지와 테마를 결정할 차례예요 '요점'부터 시작해 볼게요 탐색기 맨 위에 배치하니 개발자가 처음 보는 것 가운데 하나겠죠 그러니 전 이 부분을 가장 중요한 소개 콘텐츠로 만들고 싶어요 소개글과 튜토리얼을 강조하기 안성맞춤인 지점입니다 이러면 개발자가 단계적인 코드 사례를 빨리 찾을 수 있죠 전 개인적으로 이렇게 배우는 방식을 선호해요 이런 점을 고려해서 '요점'에 세 가지 그룹을 구성하기로 했죠 '슬로스크리에이터 소개' 튜토리얼과 '슬로스크리에이터 시작하기'란 글이에요 그다음은 제 프레임워크의 핵심 API인 슬로스 구조체죠 다른 세 그룹에도 같은 프로세스를 반복하죠 이해하기 쉬운 듯해요 가장 중요하고 광범위한 테마부터 보이니까요 제가 더 분석하면 그룹이 더 명확해지며 진보됩니다 예를 들어 '요점'에 들어가면 '시각적 속성 파악'이 나와요 '시각적 속성 파악'에 들어가면 '표준 색상 파악'이 나오고요 좋아요, 개발자가 이 콘텐츠를 잘 둘러보게끔 제 문서를 정리했습니다 다음 차례로 제 토픽 그룹의 제목 역시 수준을 높이고 싶어요 훌륭한 그룹 토픽 제목의 첫 번째 특징은 명확하고 서술적이어야 한다는 점이죠 자체적으로 합당해야 좋은 제목이에요 그래서 부가적인 내용이 별로 필요 없죠 제 토픽 제목을 다시 떠올리면 개선할 여지가 좀 남아 있어요 제가 마지막으로 쓴 토픽 제목은 '관리'였죠 이 API 그룹의 관건은 나무늘보가 행복하게 관리하는 거예요 그러니 '활동'과 '돌보기 일정', '먹이 생성기' '나무늘보 음식'을 만들죠 얼핏 보면 좋은 제목 같아요 하지만 더 심사숙고 해 보면 '관리'는 너무 포괄적인 용어죠 온갖 의미로 해석할 수 있으니까 이상적이지 못해요 보다 명확하고 서술적으로 만들게 '보살피고 먹이기'라고 부르겠어요 제 나무늘보를 보살피고 먹이를 주는 게 이 그룹의 관건인 걸 파악했죠 이런 이유로 토픽 그룹 제목이 상호 배타적이어야 한다는 점도 중요해요 대체할 수 있는 제목이면 제가 찾는 게 어디 들어 있나 알아내기 힘들어요 예를 들어 보죠 '초능력 지원' '마법의 능력 터득' '마법 걸기' 무척 비슷한 테마라서 한 가지 제목 아래 정리할 수 있을 거예요 최대한 상호 배타적으로 이름을 정해서 다음에 어디로 갈지 개발자가 간단히 파악하게 만들었죠 이런 구성과 페이지 제목에 공을 더 들일수록 개발자가 찾는 페이지로 순조롭게 찾아갈 가능성도 더 커져요 그리고 뜻밖의 재미도 찾으라고 추천할게요 다르게 표현하면 행복한 사고 같겠죠 심사숙고한 테마를 나란히 배치해서 개발자가 적절하고 관련 있는 페이지를 찾게끔 해 줘요 예를 들어 슬로스크리에이터 '요점'을 배우다 목록에 '마법의 능력 터득'이 나오면 신나잖아요 이런 팁과 요령 덕분에 제 문서 수준을 한 단계 더 끌어올렸죠 훨씬 더 나아졌어요 이제 여러분의 콘텐츠 검색을 개선하고 개발자가 이해하기 쉽게 해 주는 방법을 복습하죠 우선 여러분 문서의 주요 테마를 확인해야 해요 그리고 중요도와 특수성에 따라 여러분의 페이지를 정리하고요 그다음엔 관련 있는 테마를 나란히 배치해 뜻밖의 재미를 선사해야죠 마지막으로 여러분의 페이지와 그룹의 제목을 명확하고 상호 배타적이게 쓰세요 문서 잘 만드는 법을 배우고자 시간을 내주셔서 감사해요 분명히 개발자들이 무척 고마워할 거예요 WWDC를 즐겨 보세요! ♪