इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- SymPy
- टेक्निकल राइटर:
- lglattly
- प्रोजेक्ट का नाम:
- सभी दस्तावेज़ों में एक जैसी शैली का इस्तेमाल करना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट के लिए, मेरा मकसद SymPy के दस्तावेज़ों को ज़्यादा बेहतर बनाना है.
अपने मेंटॉर के साथ काम करते हुए, मुझे सबसे पहले कोडबेस में docstring के लिए सही फ़ॉर्मैट की पहचान करनी होगी. इसके बाद, मैं कोडबेस में मौजूद सभी दस्तावेज़ों के लिए, दस्तावेज़ को फ़ॉर्मैट करने की गाइड बनाऊंगा. इस प्रोजेक्ट में, मौजूदा दस्तावेज़ों को अपडेट करने के लिए नई गाइड को लागू करना भी शामिल है. साथ ही, भाषा के इस्तेमाल या शब्दों जैसी अन्य गड़बड़ियों को इकट्ठा करना और उनका समाधान करना भी शामिल है. मेरे मेंटर और मैं, इन अतिरिक्त अंतरों को मैनेज करने के लिए संपादकीय फ़ैसले एक साथ लेंगे. साथ ही, इन फ़ैसलों के आधार पर, गाइड में स्टाइल से जुड़ी प्राथमिकताएं भी जोड़ी जाएंगी.
इस प्रोजेक्ट का मकसद, दस्तावेज़ को फ़ॉर्मैट करने और स्टाइल से जुड़ी गाइड बनाना है. इसका इस्तेमाल डेवलपर और योगदान देने वाले, दोनों कर सकते हैं. इससे SymPy के दस्तावेज़ों में अब और आने वाले समय में एक जैसी शैली बनी रहेगी.