इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- moja global
- टेक्निकल राइटर:
- अंथनी
- प्रोजेक्ट का नाम:
- रिपोर्टिंग टूल कोड का दस्तावेज़
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
Moja Global संगठन के लिए रिपोर्टिंग टूल को दस्तावेज़ के तौर पर तैयार करने का मौका मिलने पर, मेरा सुझाव है कि छह तरह के दस्तावेज़ बनाए जाएं. अलग-अलग कामों के लिए, अलग-अलग ऑडियंस इनका इस्तेमाल कर सकेगी. इनके बारे में यहां खास जानकारी दी गई है:
1)पर्यावरण सेटअप गाइड
1.1) टारगेट ऑडियंस सिस्टम इंजीनियर
1.2) मकसद सिस्टम इंजीनियर को रिपोर्टिंग टूल के लिए, लोकल बिल्ड और एक्सीक्यूशन एनवायरमेंट सेट अप करने में मदद करना.
1.3) फ़ॉर्मैट यह एक 'कैसे करें' लेख है. इसमें सिस्टम इंजीनियर को रिपोर्टिंग टूल बनाने और उसे चलाने के लिए, क्रम से किए जाने वाले चरणों के बारे में बताया गया है.
2)बिल्ड गाइड
2.1) टारगेट ऑडियंस सिस्टम इंजीनियर
2.2) मकसद सिस्टम इंजीनियरों को सोर्स कोड से रिपोर्टिंग टूल के कॉम्पोनेंट बनाने में मदद करना
2.3) फ़ॉर्मैट कैसे करें एक लेख, जो क्रम से चलने वाले चरणों का वह सेट देता है जिसे सिस्टम इंजीनियर को रिपोर्टिंग टूल के सोर्स कोड को पाने और कंपाइल करने के लिए करना चाहिए.
3)इंस्टॉल करने का तरीका बताने वाली गाइड
3.1) टारगेट ऑडियंस सिस्टम इंजीनियर
3.2) उद्देश्य नए बनाए गए रिपोर्टिंग टूल घटकों को इंस्टॉल करने में सिस्टम इंजीनियर की सहायता करें
3.3) फ़ॉर्मैट यह एक 'कैसे करें' लेख है. इसमें, नए सेटअप किए गए एनवायरमेंट पर रिपोर्टिंग टूल को डिप्लॉय करने के लिए, सिस्टम इंजीनियर को क्रम से अपनाने वाले चरणों के बारे में बताया गया है.
4)ऑपरेशन गाइड
4.1) टारगेट ऑडियंस सिस्टम इंटिग्रेटर
4.2) मकसद सिस्टम इंजीनियर को हाल ही में इंस्टॉल किए गए रिपोर्टिंग टूल के इंस्टेंस को चलाने में मदद करना
4.3) फ़ॉर्मैट यह एक 'कैसे करें' लेख है. इसमें, सिस्टम इंटिग्रेटर को रिपोर्टिंग टूल के किसी चालू इंस्टेंस पर, फ़्लक्स आउटपुट डेटाबेस को अपलोड और प्रोसेस करने के लिए, क्रम से किए जाने वाले चरणों के बारे में बताया गया है.
ऑपरेशन गाइड रिपोर्टिंग टूल में फ़्लक्स आउटपुट डेटाबेस को शामिल करना और प्रोसेस करना
5)उपयोगकर्ता गाइड
5.1) टारगेट ऑडियंस असली उपयोगकर्ता
5.2) मकसद असली उपयोगकर्ताओं को रिपोर्टिंग टूल में जोड़ी गई अलग-अलग सुविधाओं और इन सुविधाओं को इस्तेमाल करने के तरीके के बारे में बताना.
5.3) 'कैसे करें' लेख का फ़ॉर्मैट: इसमें रिपोर्टिंग टूल के फ़ंक्शन का सही तरीके से इस्तेमाल करने के लिए, असली उपयोगकर्ताओं को क्रम से अपनाने वाले चरणों के बारे में बताया गया हो.
6) डेवलपमेंट गाइड
6.1) टारगेट ऑडियंस प्रोग्रामर
6.2) मकसद असल उपयोगकर्ताओं को रिपोर्टिंग टूल में जोड़ी गई अलग-अलग सुविधाओं और इन सुविधाओं को इस्तेमाल करने के तरीके के बारे में बताना.
6.3) रेफ़रंस वाले लेखों का फ़ॉर्मैट, जिनमें: ए) टूल को बनाने वाले मुख्य डिज़ाइन एलिमेंट b)ऊपर दिए गए एलिमेंट के फ़ंक्शनल डिकंपोज़िशन c) फ़ंक्शनल रूप से डिकपोज़ किए गए एलिमेंट डी)टूल का सोर्स कोड / लाइब्रेरी संगठन e) लगातार सुधार करने के लिए दीर्घावधिक विज़न और दिशा f) सुधार की ज़रूरत
साथ ही, एक छोटा ट्यूटोरियल, जिसमें बताया गया है कि कोड को उपयोगकर्ता की खास स्थितियों के हिसाब से कैसे अडजस्ट किया जा सकता है