مشروع Ensembl
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في
"موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Ensembl
- الكاتب الفني:
- laurelm
- اسم المشروع:
- مستندات REST API
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تحسين دليل المستخدم للمطوّرين لاستخدام Ensembl REST API
التركيز الرئيسي -- توفير مقدمة أكثر سهولة في الاستخدام/قسم الخطوات الأولى.
يعتمد التنفيذ المقترح على أسطر صفحات المستند هذه:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
الصفحة الرئيسية:
تتضمّن هذه الأقسام (عرض المستوى الأعلى):
نظرة عامة على المزايا التي توفّرها واجهة برمجة التطبيقات هذه من الناحية العملية
مقدّمة قصيرة عن REST
مثال سريع
معلومات المصادقة
مقدمة عن كيفية تنظيم عناوين URL باستخدام طرق HTTP المختلفة
معلومات عن المَعلمات المطلوبة والاختيارية ومكان العثور عليها في مستندات نقاط النهاية التي يتم إنشاؤها تلقائيًا
رابط إلى صفحة التدريب التالية:
https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
معلومات عن الدوال المساعدة المستخدَمة في الدورة التدريبية
الصفحات اللاحقة
قد تحتاج بعض المواضيع إلى الربط بصفحات التفاصيل اللاحقة بناءً على مدى تعقيد المواضيع المدرَجة في الصفحة الرئيسية.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)
[[["يسهُل فهم المحتوى.","easyToUnderstand","thumb-up"],["ساعَدني المحتوى في حلّ مشكلتي.","solvedMyProblem","thumb-up"],["غير ذلك","otherUp","thumb-up"]],[["لا يحتوي على المعلومات التي أحتاج إليها.","missingTheInformationINeed","thumb-down"],["الخطوات معقدة للغاية / كثيرة جدًا.","tooComplicatedTooManySteps","thumb-down"],["المحتوى قديم.","outOfDate","thumb-down"],["ثمة مشكلة في الترجمة.","translationIssue","thumb-down"],["مشكلة في العيّنات / التعليمات البرمجية","samplesCodeIssue","thumb-down"],["غير ذلك","otherDown","thumb-down"]],["تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)"],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
