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