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

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

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

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

מידע לגבי עובדות לגבי אוכל

כתב טכני:

FutureOfDocs

שם הפרויקט:

תיעוד של Open Food Facts API

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

תקופה ארוכה (5 חודשים)

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

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

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

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

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

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

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