בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- פתיחת 'עובדות לגבי אוכל'
- כותבים טכניים:
- FutureOfDocs
- שם הפרויקט:
- תיעוד של Open Food Facts API
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
שמעתי לראשונה על 'עונת המסמכים' באימייל שקיבלתי מהמרצה של קורס בנושא מסמכי עזרה של API ל-REST שלקחתי לפני כמה חודשים. אמנם מצאתי את הרעיון מאוד מעניין, אבל החלטתי שאשלח בקשה להצטרף לפרויקט רק אם אוכל להתחבר אליו באמת. זה היה משהו שאעשה בנוסף לעבודה הרגילה שלי, ואם אעשה את זה, זה חייב להיות כיף ומשמעותי.
כשקראתי את התיאור של 'עובדות על אוכל פתוח', ידעתי שמצאתי את הפרויקט הזה. אני אוהבת לטפל בגוף ובבריאות שלי באמצעות פעילות גופנית ואוכל. לדעתי תזונה היא אחד המפתחות לחיים מאושרים, וכל אחד צריך להיות מסוגל לקבל החלטות טובות יותר. זה אפשרי רק אם יש לנו מספיק מידע על המזון והקוסמטיקה שבהם אנחנו משתמשים. התכונה Open Food Facts (עובדה בתחום המזון) מאפשרת לנו להשתמש במידע הזה, ואני רוצה לתרום ליוזמה המדהימה הזו.
בשלוש השנים האחרונות עבדתי ככותבת טכנית בחברת פיתוח תוכנה שמתמחה באוטומציה של תהליכים והשקות. בין היתר, הטמענו API ל-REST עם Swagger שמאפשר למפתחים לתקשר עם האפליקציות שלנו באמצעות בקשות API. עזרתי לצוותים של הפיתוח לכתוב תיאורים טובים יותר לבקשות/תשובות, ויחד זיהינו איזה מידע הלקוחות שלנו צריכים כדי לספק אותו בצורה ברורה ותמציתית.
בדקתי את האתר הנוכחי של Open Food Facts API ואני חושבת שנוכל לבנות מחדש את התיעוד ולשפר אותו כדי להפוך אותו לידידותי יותר למשתמש (דפים כלליים, READ, WRITE). בנוסף, אשמח להגדיר, יחד עם צוותי הפיתוח, דרך ליצור את מסמכי התיעוד של ה-API באופן אוטומטי מהקוד (התהליך הזה אורך זמן, ולכן אני מציע שיתוף פעולה ארוך טווח).
כולנו יודעים שזה חשוב לנו ;) לכן אנחנו יכולים גם לשנות את ה-CSS והלוגו של API ל-REST כך שיתאימו בין ממשק המשתמש של הססגוניות למסמכי התיעוד למשתמש.
אני מצפה לעבוד איתך על הפרויקט הזה!