ट्राइटन प्रोजेक्ट

इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

ट्रिटन

तकनीकी लेखक:

डेव

प्रोजेक्ट का नाम:

बेसिक मॉड्यूल के लिए दस्तावेज़

प्रोजेक्ट की अवधि:

मानक अवधि (तीन महीने)

प्रोजेक्ट का विवरण

इस प्रोजेक्ट में, मेरा सुझाव है कि मैं बेसिक ट्राइटन मॉड्यूल के लिए दस्तावेज़ की समीक्षा करके उन्हें अपडेट करूं. ये ऐसे मॉड्यूल हैं जिन्हें आम तौर पर, ट्राइटन सिस्टम को सेट अप करते समय लोगों को चालू करना होता है.

ट्राइटन के मॉड्यूल दस्तावेज़ में सुधार किए जाने से उपयोगकर्ताओं को उनकी ज़रूरतों के लिए सही मॉड्यूल खोजने में मदद मिलेगी और फिर उन्हें अपना सिस्टम सेटअप करने और इस्तेमाल करने में मदद मिलेगी. अच्छे मॉड्यूल दस्तावेज़ से उपयोगकर्ताओं को चर्चा फ़ोरम में उनके जवाबों का इंतज़ार किए बिना अपने कुछ बुनियादी सवालों के जवाब ढूंढने में मदद मिलेगी.

बुनियादी मॉड्यूल में कम से कम ये चीज़ें शामिल होती हैं: account, account_invoice, account_invoice_stock, account_product, कंपनी, देश, मुद्रा, पार्टी, प्रॉडक्ट, खरीदारी, सेल, और स्टॉक मॉड्यूल.

Tyton के दस्तावेज़ के लिए तीन मुख्य ऑडियंस हैं: उपयोगकर्ता, सिस्टम एडमिन, और डेवलपर. दस्तावेज़ को इनमें से हर एक को टारगेट करने में मदद के लिए, मेरा सुझाव है कि हर मॉड्यूल के दस्तावेज़ को दस्तावेज़ डायरेक्ट्री में अलग-अलग फ़ाइलों में बांट दिया जाए. इसमें विषय सूची और मॉड्यूल की जानकारी वाली फ़ाइलें, मॉड्यूल सेट अप करने के निर्देश, मॉड्यूल का इस्तेमाल करने के तरीके के बारे में जानकारी, और मॉड्यूल के डिज़ाइन और स्ट्रक्चर के बारे में जानकारी शामिल हो सकती है. मॉड्यूल की फ़ंक्शन के आधार पर, इनमें से कुछ फ़ाइलों की ज़रूरत नहीं हो सकती है और ज़रूरत के मुताबिक अतिरिक्त फ़ाइलें बनाई जा सकती हैं. मॉड्यूल में सुधार उन ही की तर्ज़ पर होंगे जिनका मैंने पार्टी मॉड्यूल के लिए पहले से सुझाव दिया है: https://codereview.tryton.org/297241003/#ps327231002

इस तरह के दस्तावेज़ों का स्ट्रक्चर करना सही रहेगा. ऐसा इसलिए, क्योंकि फ़िलहाल दस्तावेज़ों को reस्ट्रक्चर्डText फ़ाइलों का इस्तेमाल करके स्फ़िंक्स ने जनरेट किया है. जब मैं दस्तावेज़ में बदलाव करता/करती हूं, तो उन्हें ट्राइटन कोड की समीक्षा वाली साइट पर अपलोड कर दिया जाएगा, ताकि उनकी समीक्षा की जा सके और मैं ज़रूरत के मुताबिक उन्हें अपडेट कर सकूं. जब हर कोई खुश हो जाएगा, तब वे ट्राइटन में शामिल होने के लिए स्वीकृत हो जाएंगे.