لماذا يعتبر توثيق واجهة برمجة التطبيقات (API) تسويق المحتوى ذهبيًا

يذهب هذا إلى جميع المسوقين B2B SaaS الذين لديهم رفاهية محاولة البيع للمهندسين والمطورين.

إنها ليست مهمة سهلة. الأمر ليس بهذه البساطة مثل نشر إعلان ذكي أو إجراء ندوة عبر الإنترنت ممتعة. الأمر ليس بهذه البساطة مثل إنتاج كتاب إلكتروني ونشر بعض المنشورات على LinkedIn.

الأمر أكثر تعقيدًا بعض الشيء ... لكن لا يجب أن تشعر بأنه مستحيل.

بدأ الكثير من منتجات SaaS في إنشاء أنظمة بيئية للمطورين وواجهات برمجة تطبيقات لتقديم البيانات وإلهام الحلول المخصصة التي تؤدي إلى زيادة الإيرادات والنمو للأعمال.

عندما تنظر إلى نجاح النظام البيئي AppExchange الخاص بـ Salesforce والنظام الإيكولوجي للمطور Shopify المزدهر - من الواضح جدًا أن هذا النهج يمكن أن يوفر إيرادات مذهلة لكل من الشركاء والعلامة التجارية. في عام 2021 ، كسب شركاء مطوري Shopify أكثر من 230 مليون دولار وتتوقع دراسة IDC (مؤسسة البيانات الدولية) أن تساهم Salesforce بمبلغ 1.2 تريليون دولار في الاقتصادات المحلية حول العالم. ليس سيئا إيه؟ انظر إلى هذا النمو من Shopify ...

هذا لا يحدث بالصدفة.

يحدث ذلك من خلال الاستثمار في مجتمعك والاستثمار في المحتوى الذي سيدعمهم.

تعد قناة ShopifyDevs على YouTube مثالًا واضحًا لما يبدو عليه الاستثمار في مجتمعك. القناة مليئة بالمرح والتفاعل ومقاطع الفيديو المصممة بشكل جميل والتي تتحدث عن كل شيء من الخطوات التكتيكية للاستفادة من واجهة برمجة التطبيقات إلى مقاطع الفيديو الإستراتيجية عالية المستوى.

يوضح مقدار المحتوى الذي تم تحميله على هذه القناة وجودة التعديلات أن هذا ليس استثمارًا صغيرًا من قبل Shopify. إنه شيء يأخذونه على محمل الجد وقد استجاب المجتمع من خلال المشاهدة والاشتراك بطريقة هائلة.

إذا كنت في هذا المكان ، فلست مضطرًا للتحدث معك عن الفرص الموجودة في إنشاء حلول للمهندسين. إنها استراتيجية قوية والأرقام التي يقوم بها Shopify و Salesforce في نظامهم البيئي هي أمثلة رائعة على ذلك.

بصفتنا جهات تسويق ، غالبًا ما نتجاهل حقيقة أن هذه منطقة يجب أن نلعبها أيضًا.

لا يجب أن نترك الأمر لفرق المنتج لدينا للخروج وتطوير وثائق API. لا يجب أن نترك الأمر إلى كبير موظفي التكنولوجيا لإيجاد الوقت لإنشاء مجموعة كبيرة من الوثائق.

يجب أن نفكر في كيفية دعم فريقنا الهندسي لإنشاء الوثائق والمحتوى الذي سيضيف قيمة فعلية إلى حياة عملائنا.

واحدة من أفضل الطرق للقيام بذلك هي من خلال تبني وثائق رائعة والاستثمار فيها.

يتم التقليل من أهمية وثائق واجهة برمجة التطبيقات (API) الرائعة على أنها استراتيجية تسويق للمحتوى في B2B SaaS.

يمكن للتوثيق الرائع أن:

• قيادة المجال السلطة وصلات شاملة
• كوِّن الثقة مع عملائك
• احتفظ بعملائك على المدى الطويل
• ساعد في رفع مستوى المنتج
• إلهام التغطية الإعلامية
• كسب روابط خلفية عالية الجودة

وأكثر من ذلك بكثير ... إليك لمحة سريعة عن بعض أكثر مراكز التوثيق شيوعًا وفوائد تسويق المحتوى التي يقدمونها لعلاماتهم التجارية:

لكن عليك أن تعرف ما تفعله. فيما يلي ست تقنيات بسيطة يجب وضعها في الاعتبار عند إنشاء وثائق SaaS الخاصة بك. آمل أن تتمكن من استخدام هذا للتأكد من أن الوثائق التي تقوم بإنشائها لا تُستخدم فقط ولكن يتم العثور عليها أيضًا من خلال البحث وصندوق البريد الوارد لعملائك عندما يرسلها شخص ما عبر البريد الإلكتروني قائلاً "تحقق من ذلك".

دعنا نذهب اليها…

حافظ على نظافة وثائقك

لست بحاجة إلى إعادة اختراع العجلة هنا.

أظهرت لنا شركات مثل Shopify و Stripe و WorkOS و Gitlab كيف تبدو الوثائق الرائعة. لا يلزم أن يكون التنسيق مفرطًا في التعقيد.

أبقيها بسيطة.

ضع التنقل على اليسار وضع المحتوى / الرمز على اليمين. يوفر الجانب الأيمن العلوي للأشخاص القدرة على تسجيل الدخول أو التسجيل أو العثور على معلومات حول الجديد في المستندات. تأكد من توفر شريط بحث بمجرد وصول الأشخاص إلى مستندات API الخاصة بك وإذا كانت لديك الميزانية لجعل الأمور أكثر تفاعلية - قم بتضمين مقطع فيديو تمهيدي على صفحتك الرئيسية.

اجعل من السهل التنقل

أكبر نصيحتي للمسوقين الذين يحاولون إنشاء قسم توثيق في موقعهم هو التعامل مع الصفحة الرئيسية للوثائق كصفحة مقصودة. الهدف من الصفحة الأولى لمركز التوثيق الخاص بك هو (1) توجيههم إلى المسار أو النتيجة الأكثر شيوعًا و (2) تثقيفهم بشأن ما سيجدونه في وثائق الشركة.

هل سيجدون أدلة البدء السريع؟ هل سيجدون تعريفات؟ هل هناك مكان يمكنهم الذهاب إليه للحصول على المزيد من الدعم 1-1؟ حاول الإجابة على كل هذه الأسئلة في الصفحة الرئيسية من خلال إنشاء تجربة سهلة الاستخدام وسهلة المتابعة. تذكر:

هذا ليس المكان الذي تربح فيه رحلتك إلى كان.

هذا هو المكان الذي تربح فيه ترقيتك.

هناك طريقة أخرى مثيرة للاهتمام رأيتها تم تنفيذها من قبل الأشخاص في WorkOS وهي القدرة على التنقل باستخدام حالة الاستخدام. يقوم Stripe بذلك بشكل جيد من خلال وجود صفحة مستندات قبل صفحة API. يمكنك تحديد ما إذا كنت تبحث عن Business Ops Docs أو Financial Services Docs ...

منتج آخر يقوم بهذا بشكل جيد هو Twilio:

إذا كانت لديك مجموعة قوية من المنتجات ، فقم بتسهيل انتقال المستخدمين إلى الوثائق عن طريق حالات الاستخدام. استخدم التحليلات وبيانات المنتج للإبلاغ عن تحديد أولويات الوثائق وإظهار أنك تفهم نقاط الألم لدى عملائك.

قم ببناء عناوين URL الخاصة بك بامتياز

تريد أن ترى السحر الرقمي؟ قم بزيارة وثائق Stripe ، شاهد عنوان URL وقم بالتمرير ...

أثناء التمرير ، يتغير عنوان URL من docs / api إلى / api / المصادقة إلى / api / metadata وهكذا كل امتداد آخر لديهم. إنه شيء من الجمال. لماذا ا؟

لأن كل من عناوين URL هذه قابلة للربط وتوجه الأشخاص إلى هذا القسم المحدد. إنها تجربة المستخدم المثالية (التمرير اللانهائي) مع الاستمرار في تقديم Stripe القدرة على فهرسة هذه الأقسام الفردية في Google من خلال مجالهم. إنه الشيء الذي تصنع منه أحلام مُحسنات محركات البحث ...

لا يمكنك فقط استهلاك المحتوى دون الانتقال إلى صفحة جديدة - بل يمكنك أيضًا مشاركة أقسام محددة باستخدام عنوان URL. اليوم ، لدى Stripe أكثر من 45000 مجال إحالة مرتبطة بوثائقهم. تعد إستراتيجية جعل كل قسم رئيسي عنوان URL قابلًا للربط طريقة رائعة لضمان ارتباط الكتاب والمهندسين والمطورين به عند الاقتضاء.

لا تحاول "التسويق" في وثائقك

التسويق له علاقة حب وكراهية بالتوثيق.

بشكل أساسي لأن المسوقين يحبون محاولة إيجاد طرق لإضفاء الإثارة على الأشياء وإضافة "جوهر علامتهم التجارية" في كل شيء. ليس من الضروري مع الوثائق. اقطع الزغب ولا تحاول بيع منتجك أو ميزات مختلفة. التزم بما يريده الناس: الكود والتوجيه.

لا تدع الناس يفترضون أخطائهم

هذه نصيحة تكتيكية جدًا ولكن المطورين يريدون معرفة سبب عدم نجاح الأشياء.

قم بإنشاء وثائق توضح سبب وجود أخطاء في منتجك وعند محاولة البناء على النظام الأساسي الخاص بك. إنها واحدة من أكثر الأشياء التي يتم البحث عنها بشكل متكرر عندما يتعلق الأمر بالمستندات الفنية ، لكنني رأيت استبعادها من العديد من مستندات API. ضع قائمة بالأخطاء التي يمكن أن يواجهها الأشخاص واربطها بالوثائق المتعلقة بكيفية منع هذه الأخطاء.

نصيحتي الأخيرة عندما يتعلق الأمر بإنشاء وثائق رائعة هي ...

اكتب للبشر أولاً ، الروبوتات ثانيًا

قد يكون هذا هو أهم جزء من الوثائق.

تحتاج إلى إعطاء الأولوية لتجربة المطور عندما يتعلق الأمر بالوثائق قبل أن تبدأ في التفكير في كيفية عرض Google للمحتوى الخاص بك. هل القابلية للفهرسة وبنية عنوان URL والعناوين الرئيسية التي تستخدمها لوثائقك مهمة؟ لا شك.

لكن القدرة على التقاط حجم البحث تتأرجح على الكعكة بعد حل المشكلات الحقيقية وتقديم الوضوح في مستنداتك. أنشئ للناس أولاً. تحسين الثانية.

أتمنى أن يكون لديك أسبوع رائع ووجدت هذا مفيدًا. أنا مقتنع بأن التوثيق هو أحد أهم العناصر التي تم التقليل من شأنها في المزيج التسويقي للشركات التي تركز على المهندس / المطور. إذا كنت تعمل في هذه المساحات وتريد دعمًا في إنشاء محتوى يساعد مجتمعك الهندسي على أن يحبك - تواصل معنا!

أنا دائمًا ما أتحدث عن كيفية استخدام المحتوى لتشكيل الثقافة.