หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- เปิดเรื่องราวน่ารู้เกี่ยวกับอาหาร
- ผู้เขียนด้านเทคนิค:
- 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 ของ API และโลโก้ของ REST เพื่อปรับ UI แบบใหม่ให้สอดคล้องกับเอกสารของผู้ใช้ได้ด้วย
เราหวังเป็นอย่างยิ่งว่าจะได้ร่วมงานกับคุณในโปรเจ็กต์นี้