تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- الاطّلاع على معلومات عن الحقائق الغذائية (Food Facts)
- الكاتب التقني:
- FutureOfDocs
- اسم المشروع:
- توثيق واجهة برمجة التطبيقات Open Food Facts API
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
سمعت لأول مرة عن "موسم المستندات" من خلال رسالة إلكترونية تلقيتها من معلّم دورة حول وثائق واجهة برمجة تطبيقات REST التي أخذتها منذ بضعة أشهر. على الرغم من أنني أحببت الفكرة حقًا، إلا أنني قررت أنني لن أتقدم بطلب لأي مشروع إلا إذا كان بإمكاني التعرف عليه حقًا. هذا ما كنت أفعله إلى جانب وظيفتي المعتادة، وإذا قمت بذلك، يجب أن يكون ممتعًا وذات مغزى.
عندما قرأت وصف Open Food Facts، علمت أنني وجدت هذا المشروع. أحب الاعتناء بجسدي وصحتي من خلال التمارين والطعام. أعتقد أن التغذية هي أحد مفاتيح الحصول على حياة سعيدة، ويجب أن يكون بمقدورنا جميعًا اتخاذ خيارات أفضل، وهو ما لا يمكن تحقيقه إلا إذا كانت لدينا معلومات كافية عن الطعام ومستحضرات التجميل التي نستخدمها. تضع قناة Open Food Facts هذه المعلومات تحت تصرفنا، وأريد المساهمة في هذه المبادرة الرائعة.
خلال السنوات الثلاث الماضية، أعمل ككاتبة فنية في شركة تطوير برمجيات متخصصة في أتمتة العمليات والإصدارات. وقد تم تنفيذ واجهة برمجة تطبيقات REST باستخدام Swagger وغير ذلك، ما يسمح للمطوّرين بالتواصل مع تطبيقاتنا من خلال طلبات البيانات من واجهة برمجة التطبيقات. لقد ساعدت فرق التطوير على كتابة أوصاف أفضل للطلبات/الردود، وقد حددنا معًا المعلومات التي يحتاجها العملاء لتقديمها بطريقة واضحة وموجزة.
لقد راجعنا الموقع الإلكتروني الحالي لواجهة برمجة التطبيقات Open Food Facts API وأعتقد أنّه يمكننا إعادة هيكلة المحتوى وتحسينه لجعله أكثر سهولة في الاستخدام (صفحات عامة وقراءة والكتابة). بالإضافة إلى ذلك، أود إعداد طريقة مع فِرق التطوير لإنشاء مستندات واجهة برمجة التطبيقات تلقائيًا من الرمز (يستغرق هذا وقتًا، ولهذا السبب أقترح تعاونًا طويلاً).
ندرك جميعًا أهمية المظهر والغرض، لذلك يمكننا أيضًا تعديل لغة CSS والشعار لواجهة برمجة تطبيقات REST لمواءمة واجهة المستخدم المتباهية مع مستندات المستخدم.
أتطلع إلى العمل معك في هذا المشروع!