โครงการของมูลนิธิ OpenJS

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส

OpenJS Foundation

นักเขียนเชิงเทคนิค:

Light

ชื่อโปรเจ็กต์:

ปรับปรุงเอกสาร Fastify

ความยาวของโปรเจ็กต์:

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

เราจะมุ่งเน้นที่ 2 ด้าน หนึ่งในนั้นคือการจัดทำคู่มือสไตล์ ซึ่งเกี่ยวข้องกับการปรับโครงสร้างเอกสารประกอบปัจจุบันใน fastify.io ด้วย เพื่อให้ผู้ใช้ใหม่ทำตามได้อย่างราบรื่น ส่วนอีกเรื่องหนึ่งคือการปรับปรุงคุณภาพของเนื้อหาการมีส่วนร่วมแบบ Fastify เพื่อให้ผู้มีส่วนร่วมใหม่ไม่เกิดความสับสนและข้อสงสัยระหว่างทาง โดยผลลัพธ์ที่ได้ควรเป็นเส้นทางที่ชัดเจนและกระชับตั้งแต่การมีส่วนร่วมครั้งแรกไปจนถึงการทำความคุ้นเคยกับวิธีการทำงานของ Fastify

โปรเจ็กต์นี้จะแบ่งออกเป็น 4 ระยะดังต่อไปนี้ ขั้นแรกคือทำความคุ้นเคยกับเครื่องมือที่ครอบคลุมที่มีอยู่และทําความเข้าใจความต้องการด้านเอกสารประกอบในปัจจุบันได้ดียิ่งขึ้น เป้าหมายของระยะที่ 2 จะเป็นการจัดโครงสร้าง ระบุ และให้ความสําคัญกับบริบทของเป้าหมายของ Fastify สําหรับ GSoD ครั้งนี้ จากนั้นจะเริ่มระยะการใช้งาน ซึ่งเกี่ยวข้องกับการพูดคุยกับที่ปรึกษาและชุมชนนักพัฒนาซอฟต์แวร์ของ Fastify เพื่อขอความคิดเห็น ขั้นตอนสุดท้ายคือการตรวจสอบและแก้ไขหากจำเป็น รวมถึงเขียนรายงานโครงการ

เราจะพยายามทำให้โปรเจ็กต์โอเพนซอร์สนี้ประสบความสำเร็จโดยรวม