API 문서가 콘텐츠 마케팅의 황금인 이유
게시 됨: 2022-01-20이것은 엔지니어와 개발자에게 판매하려는 사치를 가진 모든 B2B SaaS 마케터에게 전달됩니다.
쉬운 일이 아닙니다. 영리한 광고를 내거나 흥미로운 웹 세미나를 진행하는 것만큼 간단하지 않습니다. eBook을 만들고 LinkedIn에 몇 개의 게시물을 올리는 것만큼 간단하지 않습니다.
조금 더 복잡합니다. 하지만 불가능하다고 느낄 필요는 없습니다.
많은 SaaS 제품이 데이터를 제공하고 비즈니스의 추가 수익과 성장을 주도하는 맞춤형 솔루션에 영감을 주기 위해 개발자 에코시스템과 API를 만들기 시작했습니다.
Salesforce의 AppExchange 에코시스템과 번성하는 Shopify 개발자 에코시스템의 성공을 살펴보면 이 접근 방식이 파트너와 브랜드 모두에 놀라운 수익을 제공할 수 있다는 것이 매우 분명합니다. 2021년에 Shopify의 개발자 파트너는 2억 3,000만 달러 이상을 벌어들였으며 IDC(International Data Corporation) 연구에서는 Salesforce가 전 세계 지역 경제에 1조 2천억 달러를 기여할 것으로 예측합니다. 나쁘지 않죠? Shopify의 이러한 성장을 보십시오…

이것은 우연히 발생하지 않습니다.
이는 커뮤니티에 투자하고 커뮤니티를 지원할 콘텐츠에 투자함으로써 발생합니다.
ShopifyDevs YouTube 채널은 커뮤니티에 대한 투자가 어떤 것인지에 대한 명확한 예입니다. 채널은 전술적 단계에서 API 활용, 높은 수준의 전략 비디오에 이르기까지 모든 것에 대해 이야기하는 재미있고 매력적이며 아름답게 디자인된 비디오로 가득 차 있습니다.
이 채널에 업로드된 콘텐츠의 양과 편집 품질은 이것이 Shopify의 작은 투자가 아니라는 것을 보여줍니다. 그들은 진지하게 받아들이고 있으며 커뮤니티는 엄청난 방식으로 시청하고 구독함으로써 응답했습니다.

당신이 이 분야에 있다면 엔지니어를 위한 솔루션을 만드는 데 존재하는 기회에 대해 이야기할 필요가 없습니다. 이는 강력한 전략이며 Shopify와 Salesforce가 생태계에서 수행하고 있는 숫자가 그 좋은 예입니다.
마케터로서 우리는 이것이 우리가 해야 할 영역이라는 사실을 종종 간과합니다.
API 문서를 개발하는 일을 제품 팀에 맡겨서는 안 됩니다. 훌륭한 문서 세트를 만들 시간을 찾기 위해 CTO에게 맡겨서는 안 됩니다.
고객의 삶에 실제로 가치를 더할 문서와 콘텐츠를 만들기 위해 자체 엔지니어링 팀을 지원할 수 있는 방법에 대해 생각해야 합니다.
이를 수행하는 가장 좋은 방법 중 하나는 훌륭한 문서를 수용하고 투자하는 것입니다.
훌륭한 API 문서는 B2B SaaS의 콘텐츠 마케팅 전략으로 크게 과소 평가됩니다.
훌륭한 문서는 다음을 수행할 수 있습니다.
- 도메인 기관을 통해 링크를 통해 드라이브
- 고객과의 신뢰 구축
- 고객을 장기적으로 유지
- 제품 향상에 도움
- 언론 보도에 영감을 불어넣다
- 양질의 백링크 획득
그 밖에도... 다음은 가장 인기 있는 문서 허브와 이들이 브랜드에 제공하는 콘텐츠 마케팅 이점에 대한 스냅샷입니다.

그러나 당신은 당신이 무엇을하고 있는지 알아야합니다. 다음은 SaaS 문서를 작성할 때 염두에 두어야 할 6가지 간단한 기술입니다. 여러분이 만들고 있는 문서가 사용될 뿐만 아니라 누군가 "이것을 확인하십시오"라고 이메일을 보낼 때 검색 및 고객의 받은 편지함을 통해서도 찾을 수 있도록 이 기능을 사용할 수 있기를 바랍니다.
가자...
문서를 깨끗하게 유지하십시오
여기서 바퀴를 재발명할 필요가 없습니다.
Shopify, Stripe, WorkOS 및 Gitlab과 같은 회사는 훌륭한 문서의 모습을 보여주었습니다. 형식이 지나치게 복잡할 필요는 없습니다.
간단하게 유지하세요.

탐색을 왼쪽에 배치하고 콘텐츠/코드를 오른쪽에 배치합니다. 오른쪽 상단에서는 로그인, 가입 또는 문서의 새로운 내용에 대한 정보를 찾을 수 있는 기능을 제공합니다. 사람들이 API 문서를 방문하는 즉시 검색 표시줄을 사용할 수 있는지 확인하고 더 많은 대화형 작업을 수행할 수 있는 예산이 있는 경우 홈페이지에 소개 비디오를 통합하세요.

탐색을 쉽게 하세요
사이트의 문서 섹션을 구축하려는 마케팅 담당자에게 가장 큰 조언은 문서 홈페이지를 방문 페이지처럼 취급하라는 것입니다. 문서 허브 첫 페이지의 목표는 (i) 가장 일반적인 경로 또는 결과로 안내하고 (ii) 회사 문서에서 찾을 수 있는 내용을 교육하는 것입니다.
빠른 시작 가이드를 찾을 수 있습니까? 그들은 정의를 찾을 수 있습니까? 더 많은 1-1 지원을 받을 수 있는 곳이 있습니까? 직관적이고 따라하기 쉬운 경험을 만들어 홈페이지에서 이 모든 질문에 답해 보세요. 기억하다:
칸 여행에서 승리한 곳은 여기가 아닙니다.
이것은 당신이 당신의 승진을 얻는 곳입니다.
WorkOS에서 구현한 또 다른 흥미로운 접근 방식은 사용 사례별로 탐색하는 기능이었습니다. Stripe은 API 페이지 이전에 문서 페이지를 가짐으로써 이를 잘 수행합니다. Business Ops Docs 또는 Financial Services Docs 중 무엇을 찾고 있는지 선택할 수 있습니다.

이 작업을 정말 잘 수행하는 또 다른 제품은 Twilio입니다.

강력한 제품 세트가 있는 경우 사용자가 사용 사례별로 문서를 쉽게 탐색할 수 있습니다. 분석 및 제품 데이터를 사용하여 문서의 우선 순위를 알리고 고객의 고충을 이해하고 있음을 보여줍니다.
탁월한 기능으로 URL 구성
디지털 매직을 보고 싶으십니까? Stripe의 문서를 방문하여 URL을 보고 스크롤하십시오…

스크롤하면 URL이 docs/ api 에서 /api/authentication, /api/metadata로 변경되고 다른 모든 확장자가 포함됩니다. 그것은 아름다움의 일입니다. 왜요?
이러한 각 URL은 연결 가능하고 사람들을 이 특정 섹션으로 유도하기 때문입니다. Stripe가 도메인을 통해 Google에서 이러한 개별 섹션을 색인화하는 기능을 계속 제공하면서 이상적인 사용자 경험(무한 스크롤)입니다. 그것은 SEO의 꿈이 만들어지는 것입니다…
새 페이지로 이동하지 않고 콘텐츠를 소비할 수 있을 뿐만 아니라 URL을 사용하여 특정 섹션을 공유할 수 있습니다. 오늘날 Stripe는 문서로 연결되는 45,000개 이상의 참조 도메인을 보유하고 있습니다. 각 주요 섹션을 링크 가능한 URL로 만드는 전략은 작성자, 엔지니어 및 개발자가 적절할 때 링크할 수 있도록 하는 좋은 방법입니다.
문서에서 '마케팅'을 시도하지 마십시오.
마케팅은 문서화와 애증의 관계를 가지고 있습니다.
주로 마케터들은 양념을 하고 모든 것에 '브랜드 본질'을 추가하는 방법을 찾는 것을 좋아하기 때문입니다. 문서에는 필요하지 않습니다. 보풀을 자르고 제품이나 다양한 기능을 판매하려고하지 마십시오. 사람들이 원하는 것, 즉 코드와 방향에 충실하십시오.
사람들이 '자신의 오류를 가정'하게 하지 마십시오.
이것은 꽤 전술적인 조언이지만 개발자는 작동하지 않는 이유를 알고 싶어합니다.
제품에 오류가 있는 이유와 플랫폼에서 빌드를 시도할 때 오류가 발생하는 이유를 보여주는 문서를 작성하십시오. 기술 문서와 관련하여 가장 자주 검색되는 항목 중 하나이지만 많은 API 문서에서 누락된 것을 보았습니다. 사람들이 만날 수 있는 오류 목록을 만들고 이러한 오류를 방지할 수 있는 방법에 대한 문서에 링크하십시오.
훌륭한 문서 작성에 관한 마지막 조언은 다음과 같습니다.
인간을 위해 먼저 작성하고, 두 번째로 봇을 위해 작성하십시오.
이것은 문서에서 가장 중요한 부분일 수 있습니다.
Google에서 콘텐츠를 보는 방식에 대해 생각하기 전에 문서와 관련하여 개발자 경험의 우선 순위를 지정해야 합니다. 문서에 사용하는 색인 생성 가능성, URL 구조 및 헤드라인이 중요합니까? 의심의 여지가 없습니다.
그러나 검색량을 캡처하는 기능은 실제 문제를 해결하고 문서에서 명확성을 제공한 후에 케이크에 결정적입니다. 먼저 사람을 위해 만듭니다. 두 번째로 최적화하십시오.
놀라운 한 주를 보내고 도움이 되었기를 바랍니다. 저는 문서화가 엔지니어/개발자 중심 회사의 마케팅 믹스에서 가장 중요하고 과소평가된 요소 중 하나라고 확신합니다. 이러한 공간에서 일하고 있고 엔지니어링 커뮤니티가 귀하를 사랑하는 데 도움이 될 콘텐츠를 만드는 데 지원이 필요하면 연락하십시오!
저는 콘텐츠가 문화를 형성하는 데 어떻게 사용될 수 있는지에 대해 항상 이야기하고 있습니다.
