דף זה מכיל את הפרטים של פרויקט כתיבה טכני שהתקבל בעונת Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- המבנה
- כתב טכני:
- laurelm
- שם הפרויקט:
- מסמכי תיעוד של API ל-REST
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
שיפור המדריך למשתמש למפתחים לשימוש ב-Ensembl REST API
התמקדות עיקרית – יש לספק מבוא/קטע לתחילת העבודה בצורה ידידותית יותר למשתמש.
ההצעה ליישום מבוססת על ההנחיות של דפי המסמך הבאים:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
דף ראשי:
כולל את הקטעים הבאים (תצוגה ברמה גבוהה):
סקירה כללית של מה שה-API הזה מספק, מבחינה מעשית
מבוא קצר ל-REST
דוגמה קצרה
פרטי אימות
מבוא לאופן המבנה של כתובות האתרים באמצעות שיטות HTTP שונות
מידע על הפרמטרים הנדרשים והאופציונליים ועל המיקום שלהם במסמכי התיעוד שנוצרים באופן אוטומטי לגבי נקודות קצה.
קישור לדף ההדרכה הבא: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
מידע על helper_functions שנעשה בהן שימוש בקורס ההכשרה
הדפים הבאים
בהתאם למורכבות של הנושאים המפורטים בדף הראשי, ייתכן שיהיה צורך לקשר נושאים מסוימים לדפי הפרטים הבאים.