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