Dlaczego dokumentacja API to złoto w marketingu treści

To jest skierowane do wszystkich moich marketerów B2B SaaS, którzy mają luksus sprzedawania inżynierom i programistom.

To nie jest łatwa praca. To nie jest tak proste, jak wystawienie pomysłowej reklamy lub prowadzenie ciekawego webinaru. To nie jest tak proste, jak stworzenie ebooka i umieszczenie kilku postów na LinkedIn.

To trochę bardziej skomplikowane… Ale nie musi wydawać się to niemożliwe.

Wiele produktów SaaS zaczęło tworzyć ekosystemy programistyczne i interfejsy API, aby oferować dane i inspirować niestandardowe rozwiązania, które zapewniają dodatkowe przychody i wzrost firmy.

Kiedy spojrzysz na sukces AppExchange Ecosystemu Salesforce i dobrze prosperującego Shopify Developer Ecosystem – oczywiste jest, że takie podejście może zapewnić niesamowite dochody zarówno partnerom, jak i marce. W 2021 r. partnerzy programistyczni Shopify zarobili ponad 230 milionów dolarów, a badanie IDC (International Data Corporation) przewiduje, że Salesforce przyniesie 1,2 biliona dolarów lokalnym gospodarkom na całym świecie. Nieźle, co? Spójrz na ten wzrost od Shopify…

To nie dzieje się przypadkowo.

Dzieje się tak, inwestując w swoją społeczność i inwestując w treści, które będą ją wspierać.

Kanał YouTube ShopifyDevs jest wyraźnym przykładem tego, jak wygląda inwestycja w Twoją społeczność. Kanał jest wypełniony zabawnymi, wciągającymi i pięknie zaprojektowanymi filmami, które opowiadają o wszystkim, od kroków taktycznych, przez wykorzystanie interfejsu API, po filmy strategiczne na wysokim poziomie.

Ilość treści przesłanych na ten kanał i jakość edycji pokazuje, że nie jest to mała inwestycja Shopify. Traktują to poważnie, a społeczność zareagowała na to, oglądając i subskrybując na masową skalę.

Jeśli jesteś w tej przestrzeni, nie muszę z Tobą rozmawiać o możliwościach, jakie istnieją w tworzeniu rozwiązań dla inżynierów. Jest to potężna strategia, a liczby, które Shopify i Salesforce robią w swoim ekosystemie, są tego doskonałym przykładem.

Jako marketerzy często pomijamy fakt, że jest to obszar, w który również powinniśmy się bawić.

Nie powinniśmy po prostu pozostawiać naszym zespołom ds. produktów opracowywania dokumentacji API. Nie powinniśmy zostawiać CTO czasu na stworzenie świetnego zestawu dokumentacji.

Powinniśmy pomyśleć o tym, jak możemy wesprzeć nasz własny zespół inżynierów w tworzeniu dokumentacji i treści, które faktycznie dodadzą wartości do życia naszych klientów.

Jednym z najlepszych sposobów, aby to zrobić, jest uwzględnienie i inwestowanie w świetną dokumentację.

Świetna dokumentacja API jest mocno niedoceniana jako strategia content marketingu w B2B SaaS.

Świetna dokumentacja może:

• Prowadź dokładne linki do autorytetu domeny
• Buduj zaufanie swoich klientów
• Zatrzymaj swoich klientów na dłuższą metę
• Pomóż podnieść produkt
• Zainspiruj relacje w mediach
• Zarabiaj wysokiej jakości linki zwrotne

I wiele więcej… Oto migawka niektórych z najpopularniejszych centrów dokumentacji i korzyści związanych z marketingiem treści, które zapewniają swoim markom:

Ale musisz wiedzieć, co robisz. Oto sześć prostych technik, o których należy pamiętać podczas tworzenia dokumentacji SaaS. Mam nadzieję, że możesz to wykorzystać, aby upewnić się, że dokumentacja, którą tworzysz, jest nie tylko używana, ale także znajdowana w wyszukiwarce i skrzynce odbiorczej klientów, gdy ktoś wyśle ​​ją do nich e-mailem z napisem „sprawdź to”.

Weźmy się za to…

Utrzymuj swoją dokumentację w czystości

Nie musisz tutaj wymyślać koła na nowo.

Firmy takie jak Shopify, Stripe, WorkOS i Gitlab pokazały nam, jak wygląda świetna dokumentacja. Format nie musi być zbyt skomplikowany.

Nie komplikuj.

Umieść nawigację po lewej stronie, a treść/kod po prawej. W prawym górnym rogu można zalogować się, zarejestrować lub uzyskać informacje o nowościach w dokumentach. Upewnij się, że jest dostępny pasek wyszukiwania, gdy tylko użytkownicy trafią na Twoje dokumenty API i jeśli masz budżet, aby uczynić rzeczy bardziej interaktywnymi – umieść film wprowadzający na swojej stronie głównej.

Ułatw sobie nawigację

Moją największą radą dla marketerów próbujących zbudować sekcję dokumentacji swojej witryny jest traktowanie strony głównej dokumentacji jak strony docelowej. Celem pierwszej strony centrum dokumentacji jest (i) skierowanie ich do najczęstszej ścieżki lub wyniku oraz (ii) poinformowanie ich o tym, co znajdą w dokumentacji firmy.

Czy znajdą przewodniki szybkiego startu? Czy znajdą definicje? Czy jest gdzieś, gdzie mogą uzyskać więcej wsparcia 1-1? Spróbuj odpowiedzieć na wszystkie te pytania na stronie głównej, tworząc środowisko, które jest intuicyjne i łatwe do naśladowania. Pamiętać:

To nie tutaj wygrywasz swoją podróż do Cannes.

To tutaj wygrywasz promocję.

Innym ciekawym podejściem, które zaimplementowali ludzie z WorkOS, była możliwość nawigacji według przypadków użycia. Stripe robi to dobrze, mając stronę Dokumentów przed stroną API. Możesz wybrać, czy szukasz dokumentów dotyczących operacji biznesowych, czy usług finansowych…

Kolejnym produktem, który robi to naprawdę dobrze, jest Twilio:

Jeśli masz solidny zestaw produktów, ułatw użytkownikom nawigację do dokumentacji według przypadków użycia. Korzystaj z analiz i danych o produktach, aby ustalać priorytety dokumentacji i pokazać, że rozumiesz problemy swoich klientów.

Zorganizuj swoje adresy URL z doskonałą strukturą

Chcesz zobaczyć magię cyfrową? Odwiedź dokumentację Stripe, obejrzyj adres URL i przewiń…

Podczas przewijania adres URL zmienia się z docs/ api na /api/authentication na /api/metadata, a więc każde inne rozszerzenie, które mają. To rzecz piękna. Czemu?

Ponieważ każdy z tych adresów URL można połączyć i kieruje ludzi do tej konkretnej sekcji. Jest to idealne wrażenia użytkownika (nieskończone przewijanie), a jednocześnie oferuje Stripe możliwość indeksowania poszczególnych sekcji w Google za pośrednictwem ich domeny. To rzecz, z której zbudowane są marzenia SEO…

Nie tylko możesz korzystać z treści bez przechodzenia na nową stronę – możesz udostępniać określone sekcje za pomocą adresu URL. Dziś Stripe ma ponad 45 000 domen odsyłających z linkami do ich dokumentacji. Strategia tworzenia z każdej kluczowej sekcji adresu URL, do którego można łączyć, to świetny sposób na zapewnienie, że pisarze, inżynierowie i programiści będą do niego dołączać, gdy jest to właściwe.

Nie próbuj „reklamować się” w swojej dokumentacji

Marketing łączy miłość i nienawiść z dokumentacją.

Głównie dlatego, że marketerzy UWIELBIAJĄ próbować znaleźć sposoby na urozmaicenie rzeczy i dodawanie ich „esencji marki” do wszystkiego. Nie jest to konieczne w przypadku dokumentacji. Odetnij puch i nie próbuj sprzedawać swojego produktu ani różnych funkcji. Trzymaj się tego, czego ludzie chcą: kodu i kierunku.

Nie pozwól ludziom „przyjmować swoich błędów”

To dość taktyczna rada, ale programiści chcą dowiedzieć się, DLACZEGO coś nie działa.

Twórz dokumentację, która pokazuje, DLACZEGO w Twoim produkcie występują błędy i podczas próby budowania na Twojej platformie. Jest to jedna z najczęściej wyszukiwanych rzeczy, jeśli chodzi o dokumentację techniczną, ale widziałem ją pominiętą w wielu dokumentach API. Zrób listę błędów, z którymi można się spotkać, i połącz się z dokumentacją dotyczącą sposobów zapobiegania tym błędom.

Moja ostatnia rada, jeśli chodzi o tworzenie świetnej dokumentacji, jest taka…

Najpierw pisz dla ludzi, potem dla robotów

To może być najważniejsza część dokumentacji.

Zanim zaczniesz myśleć o tym, jak Google będzie wyświetlać Twoje treści, musisz potraktować priorytetowo doświadczenie programisty, jeśli chodzi o dokumentację. Czy ważna jest indeksowalność, struktura adresów URL i nagłówki, których używasz w swojej dokumentacji? Bez wątpienia.

Jednak możliwość rejestrowania liczby wyszukiwań jest wisienką na torcie PO rozwiązaniu prawdziwych problemów i zapewnieniu przejrzystości w dokumentach. Najpierw twórz dla ludzi. Optymalizuj drugi.

Mam nadzieję, że masz niesamowity tydzień i znalazłeś to pomocne. Jestem przekonany, że dokumentacja jest jednym z najważniejszych i niedocenianych elementów marketingu mix dla firm inżyniersko-deweloperskich. Jeśli pracujesz w tych miejscach i potrzebujesz wsparcia w tworzeniu treści, które pomogą Twojej społeczności inżynierskiej Cię pokochać – skontaktuj się z nami!

Zawsze mam ochotę porozmawiać o tym, jak można wykorzystać treści do kształtowania kultury.