इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Tryton
- टेक्निकल राइटर:
- डेव
- प्रोजेक्ट का नाम:
- बुनियादी मॉड्यूल के लिए दस्तावेज़
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट में, मेरा सुझाव है कि Tryton के बुनियादी मॉड्यूल के दस्तावेज़ों की समीक्षा की जाए और उन्हें अपडेट किया जाए. ये ऐसे मॉड्यूल हैं जिन्हें Tryton सिस्टम सेट अप करते समय, लोगों को आम तौर पर चालू करना पड़ता है.
Tryton के मॉड्यूल दस्तावेज़ में किए गए सुधारों से, उपयोगकर्ताओं को अपनी ज़रूरतों के हिसाब से सही मॉड्यूल ढूंढने में मदद मिलेगी. साथ ही, उन्हें अपने सिस्टम को सेटअप करने और इस्तेमाल करने में भी मदद मिलेगी. मॉड्यूल के बारे में अच्छे दस्तावेज़ होने पर, उपयोगकर्ता अपने कुछ बुनियादी सवालों के जवाब पा सकते हैं. इसके लिए, उन्हें चर्चा फ़ोरम पर जवाबों का इंतज़ार नहीं करना पड़ेगा.
बुनियादी मॉड्यूल में ये शामिल हैं: account_invoice, account_invoice_stock, account_product, कंपनी, देश, मुद्रा, पक्ष, प्रॉडक्ट, purchase, बिक्री, और स्टॉक मॉड्यूल.
ट्राइटन दस्तावेज़, उपयोगकर्ताओं, सिस्टम एडमिन, और डेवलपर के लिए तीन मुख्य ऑडियंस हैं. हमारा सुझाव है कि दस्तावेज़ों को इनमें से हर एक के लिए टारगेट करने के लिए, हर मॉड्यूल के दस्तावेज़ को दस्तावेज़ डायरेक्ट्री में अलग-अलग फ़ाइलों में बांटें. इनमें ऐसी फ़ाइलें शामिल हो सकती हैं जिनमें कॉन्टेंट की टेबल और मॉड्यूल के बारे में जानकारी, मॉड्यूल को सेट अप करने के निर्देश, मॉड्यूल को इस्तेमाल करने के तरीके की जानकारी, और मॉड्यूल के डिज़ाइन और स्ट्रक्चर के बारे में जानकारी शामिल हो. मॉड्यूल के फ़ंक्शन के आधार पर, हो सकता है कि इनमें से कुछ फ़ाइलों की ज़रूरत न पड़े. साथ ही, ज़रूरत के हिसाब से अतिरिक्त फ़ाइलें बनाई जा सकती हैं. मॉड्यूल में किए गए सुधार उन अपडेट के साथ होंगे जिन्हें मैंने पार्टी मॉड्यूल के लिए पहले से सुझाया है: https://codereview.tryton.org/297241003/#ps327231002
दस्तावेज़ों की इस तरह की संरचना बनाना अच्छी तरह से काम करेगा, क्योंकि दस्तावेज़ वर्तमान में स्फ़िंक्स द्वारा restructuredText फ़ाइलों का उपयोग करके जनरेट किया जाता है. दस्तावेज़ में बदलाव करने पर, उन्हें Tryton कोड की समीक्षा करने वाली साइट पर अपलोड कर दिया जाएगा, ताकि उनकी समीक्षा की जा सके. साथ ही, ज़रूरत के हिसाब से उन्हें अपडेट किया जा सके. जब सभी लोग उनसे संतुष्ट हो जाएंगे, तब उन्हें ट्रायटन में शामिल करने की मंज़ूरी मिल सकती है.