หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- มูลนิธิ OpenJS
- ผู้เขียนด้านเทคนิค:
- แสง
- ชื่อโปรเจ็กต์:
- ยกเครื่องเอกสาร Fastify
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
เราจะโฟกัสที่ 2 ด้าน หนึ่งในนั้นคือการทำตามคู่มือสไตล์ ซึ่งยังเกี่ยวข้องกับการปรับโครงสร้างเอกสารปัจจุบันใน Fastify.io ทำให้ผู้ใช้ใหม่ทำตามได้อย่างราบรื่น อีกระบบหนึ่งจะปรับปรุงคุณภาพของเนื้อหาการมีส่วนร่วมอย่างรวดเร็ว เพื่อให้ผู้ร่วมงานรายใหม่ลดความสับสนและข้อสงสัยไปพร้อมกัน ตามหลักการแล้ว ผลลัพธ์ที่ได้จะเป็นเส้นทางที่ชัดเจนและกระชับ ตั้งแต่การมีส่วนร่วมครั้งแรกไปจนถึงการทำความคุ้นเคยกับวิธีการทำงานของ Fastify
โปรเจ็กต์นี้แบ่งเป็น 4 ระยะต่อไปนี้ ก่อนอื่นคือการทำความคุ้นเคยกับเครื่องมือที่ครอบคลุมและเข้าใจความต้องการด้านเอกสารในปัจจุบันได้ดียิ่งขึ้น เป้าหมายของเฟสที่ 2 คือการจัดโครงสร้าง ระบุ และให้ความสําคัญกับบริบทเป้าหมายของ Fastify สำหรับ GSoD นี้ จากนั้นเริ่มเฟสการนำไปใช้ ซึ่งจะมีการสลับกับที่ปรึกษาและชุมชนนักพัฒนาซอฟต์แวร์ของ Fastify เพื่อรับความคิดเห็น ขั้นตอนสุดท้ายคือการตรวจสอบและแก้ไขตามความจำเป็น รวมถึงเขียนรายงานโครงการ
ฉันจะนำประโยชน์มาสู่ความสำเร็จโดยรวมของโครงการโอเพนซอร์สนี้