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