หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- เปิดข้อเท็จจริงเกี่ยวกับอาหาร
- นักเขียนเชิงเทคนิค:
- FutureOfDocs
- ชื่อโปรเจ็กต์:
- จัดทำเอกสารเกี่ยวกับ Open Food Facts API
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ฉันได้ยินเกี่ยวกับ "Season of Docs" เป็นครั้งแรกผ่านอีเมลที่ได้รับจากผู้สอนหลักสูตรเกี่ยวกับเอกสารประกอบ REST API ที่ฉันเข้าร่วมเมื่อหลายเดือนก่อน แม้ว่าฉันจะชอบแนวคิดนี้มาก แต่ฉันตัดสินใจที่จะสมัครเข้าร่วมโครงการก็ต่อเมื่อฉันสามารถพิจารณาได้จริงๆ นี่เป็นกิจกรรมที่ฉันจะทำนอกเหนือจากงานประจำ และหากจะทำ กิจกรรมนั้นจะต้องสนุกและมีประโยชน์
เมื่ออ่านคำอธิบายของ Open Food Facts ฉันก็รู้ว่าได้พบโปรเจ็กต์นั้นแล้ว ฉันชอบดูแลร่างกายและสุขภาพผ่านการออกกำลังกายและอาหาร เราคิดว่าโภชนาการเป็นหนึ่งในกุญแจสู่ความสุขในชีวิต และเราทุกคนควรมีทางเลือกที่ดีขึ้น ซึ่งทำได้ก็ต่อเมื่อมีข้อมูลเพียงพอเกี่ยวกับอาหารและเครื่องสำอางที่ใช้ Open Food Facts นำข้อมูลนี้มาไว้ใช้งาน และฉันอยากมีส่วนร่วมในโครงการริเริ่มอันน่าทึ่งนี้
ในช่วง 3 ปีที่ผ่านมา ผมทำงานเป็นนักเขียนด้านเทคนิคของบริษัทพัฒนาซอฟต์แวร์ที่เชี่ยวชาญด้านกระบวนการและการทำงานอัตโนมัติในการเผยแพร่ผลงาน นอกจากนี้ เรายังใช้ REST API ด้วย Swagger เพื่อให้นักพัฒนาซอฟต์แวร์สื่อสารกับแอปพลิเคชันของเราผ่านคำขอ API ได้ เราได้ช่วยทีมพัฒนาเขียนคำอธิบายคำขอ/คำตอบให้ดียิ่งขึ้น และร่วมกันระบุข้อมูลที่ลูกค้าต้องการเพื่อให้ข้อมูลในลักษณะที่ชัดเจนและกระชับ
เราได้ตรวจสอบเว็บไซต์ Open Food Facts API ปัจจุบันและคิดว่าเราสามารถปรับโครงสร้างและปรับปรุงเอกสารประกอบเพื่อให้ใช้งานง่ายขึ้น (หน้าทั่วไป อ่าน เขียน) นอกจากนี้ เรายังต้องการสร้างวิธีสร้างเอกสารประกอบ API จากโค้ดโดยอัตโนมัติร่วมกับทีมพัฒนา (การดำเนินการนี้ต้องใช้เวลา เราจึงขอเสนอการทำงานร่วมกันในระยะยาว)
เราทุกคนทราบดีว่ารูปลักษณ์นั้นสำคัญ ;) เราจึงปรับแต่ง CSS และโลโก้ REST API เพื่อปรับ UI ของ Swagger ให้สอดคล้องกับเอกสารประกอบของผู้ใช้ได้ด้วย
หวังว่าจะได้ร่วมงานกับคุณในโปรเจ็กต์นี้