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