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