หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- แชทของทีมโอเพนซอร์สของ Zulip
- ผู้เขียนด้านเทคนิค:
- ดรโรซา
- ชื่อโปรเจ็กต์:
- การปรับโครงสร้างของ ReadTheDocument และเอกสาร API
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ฉันจะมุ่งเน้น 2 ด้านนี้ และมุ่งไปพร้อมๆ กัน หนึ่งในนั้นคือการปรับปรุงคุณภาพของ zulip.readthedocs.io เพื่อให้ผู้มีส่วนร่วมรายใหม่ลดความสับสนและความสงสัยลงได้ ตามหลักแล้ว ผลลัพธ์จะเป็นเส้นทางที่ชัดเจนและกระชับ ตั้งแต่การมีส่วนร่วมครั้งแรกไปจนถึงการทำความคุ้นเคยกับวิธีการทำงานของ Zulip นอกจากนี้ฉันวางแผนที่จะใช้ zulipchat.com/api, api.md และ openapi.md เพื่อทำให้กระบวนการบันทึกปลายทางเพิ่มเติมเข้าใจได้ง่ายขึ้น ทั้ง 2 ส่วนมีแนวโน้มที่จะเกี่ยวข้องกับการอัปเดต/การทำให้เนื้อหาเข้าใจง่าย จัดระเบียบบทความ เพิ่มเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ที่ขาดหายไป และการเขียน/ทดสอบโค้ด
โครงการจะมีทั้งหมด 4 ระยะ โดยระยะแรกจะรวมถึงโปรเจ็กต์สร้างความคุ้นเคยเล็กๆ น้อยๆ เครื่องมือเตรียมความพร้อม และการทำความเข้าใจความต้องการเอกสารในปัจจุบันให้ดียิ่งขึ้น วัตถุประสงค์ของเฟสที่ 2 คือการจัดโครงสร้าง ระบุ และจัดลำดับความสำคัญของงานในบริบทของเป้าหมายของ Zulip ในช่วงฤดูใบไม้ร่วงนี้ จากนั้นเข้าสู่ขั้นตอนการปรับใช้ของโครงการ ฉันจะคอยแลกเปลี่ยนความคิดเห็นกับเหล่า Mentor และชุมชนนักพัฒนาซอฟต์แวร์ของ Zulip เป็นประจำ ระยะสุดท้ายคือย้อนกลับไปดู แก้ไขหากจำเป็น และเขียนรายงานโครงการ
ฉันสงสัยว่าลำดับความสำคัญและงานบางอย่างมีแนวโน้มที่จะเปลี่ยนแปลงตลอดช่วงเวลาการทำงานเนื่องจากสิ่งที่คนอื่นๆ ทำอยู่ รวมถึงการตัดสินใจของนักพัฒนาแอปหลัก ฉันหวังว่าการเรียนรู้วิธีปรับตัวให้เข้ากับการเปลี่ยนแปลงดังกล่าวอย่างเหมาะสมจะเป็นแง่มุมที่จำเป็นที่จะทำให้ประสบการณ์ GSoD ประสบความสำเร็จ เมื่อถึงจุดหนึ่ง เราอาจจะเลื่อนความคิดที่เสนอไปไปไว้ภายหลังได้ กล่าวโดยทั่วไปคือ ผมจะมุ่งเน้นไปที่การตรวจสอบว่าผลงานของฉันสร้างมูลค่าให้กับความสำเร็จโดยรวมของโครงการโอเพนซอร์สของ Zulip