این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- باز کردن حقایق غذایی
- نویسنده فنی:
- FutureOfDocs
- نام پروژه:
- API Open Food Facts را مستند کنید
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
من برای اولین بار در مورد "Season of Docs" از طریق ایمیلی که از مربی دوره ای در مورد مستندات REST API که چند ماه پیش گرفتم، شنیدم. اگرچه من واقعاً این ایده را دوست داشتم، تصمیم گرفتم فقط در صورتی برای یک پروژه درخواست بدهم که واقعاً بتوانم با آن همذات پنداری کنم. این کاری بود که من در کنار کار معمولی‌ام انجام می‌دادم، و اگر آن را انجام می‌دادم، باید سرگرم‌کننده و معنادار باشد.
وقتی توضیحات Open Food Facts را خواندم، می دانستم که آن پروژه را پیدا کرده ام. من دوست دارم از طریق ورزش و غذا از بدن و سلامتی خود مراقبت کنم. من واقعا فکر می کنم تغذیه یکی از کلیدهای یک زندگی شاد است و همه ما باید بتوانیم انتخاب های بهتری داشته باشیم، که تنها در صورتی امکان پذیر است که اطلاعات کافی در مورد مواد غذایی و لوازم آرایشی که استفاده می کنیم داشته باشیم. Open Food Facts این اطلاعات را در اختیار ما قرار می دهد و من می خواهم در این ابتکار شگفت انگیز مشارکت کنم.
در سه سال گذشته من به عنوان یک نویسنده فنی در یک شرکت توسعه نرم افزار متخصص در اتوماسیون فرآیند و انتشار کار کرده ام. از جمله، ما یک REST API را با Swagger پیاده سازی کرده ایم که به توسعه دهندگان اجازه می دهد از طریق درخواست های API با برنامه های ما ارتباط برقرار کنند. من به تیم‌های توسعه کمک کرده‌ام تا توضیحات بهتری برای درخواست‌ها/پاسخ‌ها بنویسند، و با هم شناسایی کرده‌ایم که مشتریان ما به کدام اطلاعات نیاز دارند تا به روشی واضح و مختصر ارائه شوند.
من سایت فعلی Open Food Facts API را بررسی کرده‌ام و فکر می‌کنم می‌توانیم اسناد را بازسازی و ارتقا دهیم تا کاربرپسندتر شود (صفحات عمومی، READ، WRITE). علاوه بر این، من دوست دارم، همراه با تیم های توسعه، راهی برای تولید اسناد API به صورت خودکار از روی کد راه اندازی کنم (این کار زمان می برد، به همین دلیل است که من یک همکاری طولانی مدت را پیشنهاد می کنم).
همه ما می دانیم که ظاهر مهم است ؛) به همین دلیل است که می توانیم REST API CSS و لوگو را نیز تغییر دهیم تا رابط کاربری swagger را با مستندات کاربر هماهنگ کنیم.
من مشتاقانه منتظر همکاری با شما در این پروژه هستم!