פתיחת פרויקט עובדות לגבי האוכל

דף זה מכיל את הפרטים של פרויקט כתיבה טכני שהתקבל בעונת Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:

פתיחה של עובדות לגבי אוכל

כתב טכני:

FutureOfDocs

שם הפרויקט:

מתעדים את Open FoodFacs API

אורך הפרויקט:

משך זמן ארוך (5 חודשים)

תיאור הפרויקט

שמעתי לראשונה על 'עונת Docs' באימייל שקיבלתי ממורה בקורס על מסמכי תיעוד ל-API ל-REST של כמה חודשים. למרות שמאוד אהבתי את הרעיון, החלטתי שאגיש בקשה רק אם אני באמת יכולה להזדהות איתו. זה משהו שהייתי עושה בנוסף לעבודה הרגילה שלי, ואם זה היה התפקיד שלי, זה צריך להיות מהנה ומשמעותי.

כשקראתי את התיאור של 'עובדות לגבי אוכל פתוח', ידעתי שמצאתי את הפרויקט הזה. אני אוהבת לשמור על הגוף והבריאות שלי באמצעות פעילות גופנית ומזון. אני באמת חושבת שתזונה היא אחד המפתחות לחיים מאושרים, וכולנו צריכים להיות מסוגלים לקבל החלטות טובות יותר, מה שאפשר לעשות רק אם יש לנו מספיק מידע על האוכל ומוצרי הקוסמטיקה שבהם אנחנו משתמשים. התכונה 'עובדות לגבי אוכל' מאפשרת לנו לקבל גישה למידע הזה, ואני רוצה לתרום ליוזמה המדהימה הזו.

בשלוש השנים האחרונות עבדתי ככותב טכני בחברה לפיתוח תוכנה שמתמחה באוטומציה של תהליכים ושחרור. בין היתר, הטמענו API ל-REST עם Swagger, שמאפשר למפתחים לתקשר עם האפליקציות שלנו באמצעות בקשות API. עזרתי לצוותי הפיתוח לכתוב תיאורים טובים יותר לבקשות/תגובות, ויחד זיהינו איזה מידע הלקוחות שלנו נדרשים כדי לספק אותו בצורה ברורה ותמציתית.

בדקתי את האתר הנוכחי של Open FoodFacs API וחשבתי שנוכל לשנות את מבנה המסמכים ולשפר אותו כדי שיהיה ידידותי יותר למשתמש (דפים כלליים, READ, כתיבה). בנוסף, אשמח להגדיר, ביחד עם צוותי הפיתוח, דרך ליצור את התיעוד של ממשק ה-API באופן אוטומטי מתוך הקוד (זה לוקח זמן, ולכן אני מציע שיתוף פעולה ארוך טווח).

כולנו יודעים שהמראה חשוב ;) לכן אנחנו יכולים גם לשנות את ה-CSS והלוגו של API ל-REST כדי להתאים את ממשק המשתמש המוכר לתיעוד של המשתמשים.

אשמח לעבוד איתך על הפרויקט הזה!