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