تعد وثائق واجهة برمجة التطبيقات (API) مرجعًا؛ بينما يمثل العرض التقديمي للمطورين عملية تعريفية. تدرج وثائقك كل نقطة نهاية ومعلمة ورمز استجابة، لكن جمهور المطورين يحتاج أولاً إلى نموذج فكري: ما الذي تفعله واجهة برمجة التطبيقات، وكيف تعمل عملية المصادقة، وكيفية إجراء أول استدعاء. باستخدام Gamma، يمكنك ربط مصدر وثائقك أو لصق المحتوى، وترك وكيل الذكاء الاصطناعي يحول المواد المرجعية المكثفة إلى عرض تقديمي واضح ومرئي للمطورين، يتضمن المفاهيم والتدفقات وأمثلة على المكالمات، وذلك في غضون دقائق.
يكمن التحدي في ترتيب المحتوى. فالتوثيق يُنظم بهدف التسهيل على البحث، مع ترتيب العناصر أبجديًّا، وتضمين معلمات شاملة، في حين أن العرض التقديمي يجب أن يقدم المعلومات بترتيب تدريجيٍّ. لا يمكنك تدريب مطور جديد من خلال قراءة الدليل المرجعي من البداية إلى النهاية. يقوم وكيل Gamma بقراءة وثائقك، ويسأل عن الأشخاص الذين سيقومون بعملية الدمج وما يحتاجون إلى إنجازه، ثم يعيد صياغة المادة لتصبح عرضًا تقديميًّا يساعد المطورين على إجراء أول مكالمة ناجحة لهم.
العرض التقديمي القوي الذي يقدمه المطور يحول الوثائق المرجعية إلى فهم:
يشرح مقدماً وظيفة واجهة برمجة التطبيقات (API) والمشكلة التي تحلها
يتناول موضوع المصادقة في مرحلة مبكرة، لأن لا شيء يعمل بدونها
يعرض المفاهيم الأساسية ونموذج الموارد قبل نقاط النهاية
شرح تفصيلي لمكالمة أولى تتضمن طلبًا محددًا وردًّا عليه
يسلط الضوء على النقاط النهائية الرئيسية التي سيستخدمها المطورون فعليًّا أكثر من غيرها
تشير إلى الوثائق الكاملة لكل ما عدا ذلك
أفضل العروض التقديمية للمطورين هي تلك التي تجعل الجمهور يقول: «أفهم كيفية استخدام هذا»، وليس «لقد رأيت كل نقطة نهاية».
قم بربط الأداة بالمكان الذي توجد فيه مستنداتك، سواء كان Confluence أو مستودع مستندات عبر GitHub أو Notion، وستقوم Gamma باستيراد المحتوى مباشرةً، دون الحاجة إلى النسخ واللصق. هل تفضل العمل من الملف؟ قم بلصق مستنداتك المرجعية أو أدخلها بتنسيق Markdown. في كلتا الحالتين، تقوم Gamma بقراءة المحتوى وتفهمه على أنه وثائق واجهة برمجة التطبيقات (API). يستغرق ربط المصدر أقل من دقيقة، مما يجعل تحديث العرض التقديمي سريعًا عند حدوث تغييرات في واجهة برمجة التطبيقات (API).
يقوم وكيل «غاما» بالتأكد من هوية الأشخاص الذين يقومون بعملية الدمج والأهداف التي يسعون إلى تحقيقها، ويقرأ الوثائق، وينظمها في مسار تعليمي يتضمن: نظرة عامة، والتوثيق، والمفاهيم، والمكالمة الأولى، ونقاط النهاية الرئيسية، والموارد. وتصبح المواد المرجعية سردًا يهدف إلى بناء الفهم.
يقوم «Gamma» بتحويل طلباتك النموذجية إلى كتل برمجية سهلة القراءة، وتحويل تدفقات المصادقة والطلبات إلى مخططات، وتحويل نموذج الموارد إلى عناصر مرئية واضحة تلقائيًا. وبدلاً من النصوص المرجعية المطولة، يرى المطورون المفاهيم معروضة بطريقة تجعل من السهل فهمها.
قم بربط مصدر المستندات الخاص بك أو جهز المحتوى المرجعي ليكون جاهزًا لللصق. توفر النظرة العامة وعملية المصادقة وبعض نقاط النهاية الرئيسية للوكيل أكبر قدر ممكن من المعلومات التي يمكنه العمل بها.
افتح تطبيق gamma.app وابدأ من مربع الأوامر. قم بربط مستنداتك أو الصق المحتوى، ثم اطلب ما تحتاجه، على سبيل المثال: «حوّل وثائق واجهة برمجة التطبيقات (API) هذه إلى عرض تقديمي لتدريب المطورين الجدد يتناول المصادقة والمفاهيم الأساسية وأول عملية استدعاء، وذلك للمهندسين الذين يعملون على دمج واجهة برمجة التطبيقات الخاصة بنا». قدم للوكيل إجابة سريعة أو اثنتين، وسيبدأ في العمل.
تقترح «غاما» مخططًا عامًا. وعادةً ما يسير عرض المطور على النحو التالي:
وظيفة واجهة برمجة التطبيقات (API) ومتى يتم استخدامها
المصادقة والحصول على بيانات الاعتماد
المفاهيم الأساسية ونموذج الموارد
طلبك الأول والرد عليه
النقاط النهائية الرئيسية وسير العمل الشائع
الأخطاء والقيود وأفضل الممارسات
المستندات والموارد الكاملة
أعد ترتيب الأقسام أو أضفها أو احذفها لتناسب جمهورك. هل تريد بدء تعريف الشركاء الذين يحتاجون إلى تفاصيل المصادقة أولاً؟ انقل هذا القسم إلى الأعلى.
يقوم «Gamma» بإنشاء عرض تقديمي كامل ومنسق للمطورين يتضمن كتل الكود الخاصة بك ومخططات التدفق، مع الحفاظ على مظهر متسق في جميع أجزائه. أما بالنسبة لعروض الشركاء أو إحاطات الإطلاق، فيستخدم «Max mode» أقوى النماذج المتاحة لإضفاء لمسة نهائية أكثر إتقانًا.
تم إنشاء التخطيط مسبقًا، لذا يتم عرض كل مفهوم في مكانه الصحيح. عندما تريد وضع كتلة كود أو رسم تخطيطي في مكان محدد بالضبط، انتقل إلى وضع التحرير الحر وقم بضبط موضعه بدقة. هل تفضل وصف التغيير؟ استخدم التحرير بالذكاء الاصطناعي، واختر أي عنصر وأخبر Gamma بما يجب فعله، مثل «اعرض مسار المصادقة في شكل مخطط» أو «قم بتمييز المعلمات المطلوبة». صقل كل عنوان ليتركز على الفكرة الوحيدة المهمة.
قم بتقديم عرض مباشر، أو شارك رابطًا تفاعليًّا على الويب يمكن للمطورين الرجوع إليه، أو قم بالتصدير إلى PowerPoint أو PDF أو Google Slides. يتم الاحتفاظ بالكود والرسوم التوضيحية والتنسيق، بحيث يحصل المطورون على المواد بأي تنسيق يفضلونه.
Gamma مقابل العرض المباشر من المستندات
التنسيق: يتم تنظيم المستندات لتسهيل البحث؛ أما العرض التقديمي فيحتاج إلى ترتيب يساعد على الفهم
Pace: المواد المرجعية تملأ الغرفة؛ أما Gamma فتستخرج فقط ما يحتاجه المطورون في البداية
العناصر المرئية: تتسم المستندات بكثرة النصوص؛ ويقوم تطبيق «Gamma» بتحويل المسارات والمفاهيم إلى رسوم بيانية
النصيحة الصادقة: اجعل وثائق واجهة برمجة التطبيقات (API) مرجعًا شاملاً، فهذا هو الغرض منها بالضبط. وعندما تقوم بتدريب المطورين بشكل مباشر، دع «Gamma» تحول الوثائق إلى عرض تقديمي تعليمي، مع الإشارة إلى المرجع الكامل للحصول على التفاصيل.
Gamma مقابل PowerPoint
المصدر: يفتح برنامج PowerPoint بصفحة فارغة؛ ويقوم برنامج Gamma بقراءة مستنداتك أو المصدر المتصل مباشرةً
التحديثات: عندما تتغير واجهة برمجة التطبيقات (API)، يتعين إجراء التحديثات يدويًّا في PowerPoint؛ أما في Gamma، فيمكنك إعادة الإنشاء من المصدر بسرعة
التصميم: جودة PowerPoint تعتمد عليك؛ بينما تظل قيمة جاما ثابتة
الرأي الصريح: يمنحك برنامج PowerPoint تحكمًا كاملاً في إعداد عرض تقديمي مخصص. أما لتحويل الوثائق إلى عرض تقديمي للتأهيل الوظيفي بسرعة، فإن Gamma تساعدك على إنجاز ذلك بشكل أسرع، ويمكنك التصدير مرة أخرى إلى PowerPoint في أي وقت.
ابدأ بالنموذج الذهني. يجب على المطورين فهم بنية واجهة برمجة التطبيقات (API) قبل التعرف على نقاط النهاية.
تأكد من المصادقة في مرحلة مبكرة. لن يعمل أي شيء آخر حتى تتم المصادقة، لذا لا تهمل هذه الخطوة.
اعرض مثالاً حقيقياً للمكالمة الأولى. فالطلب والاستجابة الملموسان يقدمان معلومات أكثر مما يقدمه جدول المعلمات.
لا تقم بعرض كل نقطة نهاية. ركز على النقاط القليلة التي يستخدمها المطورون بشكل أكبر، وقم بإضافة روابط إلى البقية.
احرص على إتاحة المرجع الكامل. أشر إلى الوثائق للحصول على التفاصيل الشاملة بدلاً من حشرها في النص.
نعم. قم بربط Confluence أو مستودع مستندات GitHub أو Notion أو أي مكان آخر توجد فيه مستنداتك، وستقوم Gamma باستيراد المحتوى مباشرةً. يمكنك أيضًا لصق المواد المرجعية إذا كنت تفضل ذلك.
نعم. يقوم «Gamma» بعرض الكود في كتل واضحة وسهلة القراءة. احرص على أن تكون الأمثلة التي تعرضها مركزة، واستخدم ميزة التحرير بالذكاء الاصطناعي لإبراز المعلمات المطلوبة أو الأسطر الرئيسية.
يقوم «Gamma» بتحويل المسارات التي وصفتها إلى مخططات واضحة. يمكنك تحسينها من خلال التحرير الحر أو طلب من الوكيل تبسيط أحد المسارات.
إذا كان مصدر مستنداتك متصلاً، فاطلب من Gamma تحديث المحتوى، أو احفظه كقالب. سيبقى الهيكل كما هو؛ ولن يتغير سوى المحتوى.
تصف وثائقك بالفعل كل نقطة نهاية، لكنها مصممة للبحث فقط، وليس للتدريب. قم بربط وثائقك أو لصق المحتوى، وأخبر «Gamma» عن جمهورك وأهدافهم، ودع الوكيل يحول المرجع إلى عرض تقديمي تعليمي يتضمن أكواد برمجية ورسوم توضيحية. ستتمكن من مساعدة المطورين على إتمام أول مكالمة ناجحة لهم بسرعة.
