इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- The Linux Foundation
- टेक्निकल राइटर:
- xiaoya
- प्रोजेक्ट का नाम:
- CHAOSS D&I बैजिंग प्रोजेक्ट के लिए दस्तावेज़ बनाएं
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड लंबाई (तीन महीने)
प्रोजेक्ट का विवरण
मैंने मुख्य कॉन्टेंट को यहां रखा है: मुख्य लक्ष्य, वर्कफ़्लो में दस्तावेज़ से जुड़े कामों को बेहतर बनाना, कम्यूनिटी के लिए डी&आई बैजिंग दस्तावेज़ लिखना, और खास प्लैटफ़ॉर्म पर कई भाषाओं में प्रोसेस किए गए दस्तावेज़ों को होस्ट करना है. इन्हें इन छोटे टास्क में बांटा जा सकता है: डी&आई मेट्रिक के ज़्यादा इस्तेमाल में, मौजूदा पीआर टेंप्लेट को अपडेट और इंटिग्रेट करें. साथ ही, सवालों में विविधता लाएं. डी&आई बैजिंग प्रोग्राम को पेश करने के लिए, कॉन्सेप्ट की खास जानकारी ड्राफ़्ट करें जैसे-जैसे JOSS दस्तावेज़ों का इस्तेमाल करके, आवेदन करने वाले के लिए दिशा-निर्देश ड्राफ़्ट करें जैसे-जैसे JOSS दस्तावेज़ों का इस्तेमाल करके, समीक्षक के लिए दिशा-निर्देश ड्राफ़्ट करें वह दस्तावेज़ जिसमें पूरे वर्कफ़्लो में अलग-अलग भूमिकाओं और उनकी ज़िम्मेदारियों के बारे में बताया गया हो. एक दस्तावेज़, जिसमें बताया गया है कि वर्कफ़्लो के लिए GitHub probot को कैसे लागू किया जाता है योगदान देने वाले के लिए दिशा-निर्देश, जिसमें बताया गया है कि नया व्यक्ति प्रोजेक्ट या दस्तावेज़ में कैसे योगदान दे सकता है. दस्तावेज़ों के अनुवाद में मदद करना, खास तौर पर चीनी भाषा में अपने-आप होने वाले अनुवाद की परफ़ॉर्मेंस की जांच करना, और ज़रूरत पड़ने पर मैन्युअल तरीके से अनुवाद करना. अनुवाद के काम के आधार पर, दस्तावेज़ को कई भाषाओं में उपलब्ध फ़ॉर्मैट में व्यवस्थित करें. दस्तावेज़ को होस्ट करने के लिए, Gitbook, Read the Doc या GitHub Wiki का इस्तेमाल करें.
डिलीवर किए जाने वाला कॉन्टेंट 1. प्रोजेक्ट और इवेंट के पीआर टेंप्लेट को ज़्यादा मेट्रिक और अलग-अलग सवालों से बेहतर बनाएं. इस प्रोग्राम में, वर्कफ़्लो में दस्तावेज़ से जुड़े सभी काम शामिल होते हैं. खास तौर पर, आवेदकों के लिए तैयार किए गए पीआर टेंप्लेट. यह हमारे वर्कफ़्लो का मुख्य कॉम्पोनेंट है, क्योंकि यह समीक्षकों की समीक्षा का अहम हिस्सा होता है. इसलिए, वर्कफ़्लो के दौरान सवालों के फ़ॉर्मैट और कॉन्टेंट को बेहतर बनाया जाएगा. साथ ही, हम इसे यहां बताए गए तरीकों से पेश करेंगे: अलग-अलग तरह के इवेंट या प्रोजेक्ट के अलग-अलग जवाब की ज़रूरत को ध्यान में रखते हुए
डिलीवर की जाने वाली दूसरी चीज़. यहां कम्यूनिटी के लिए दस्तावेज़ के स्ट्रक्चर का ड्राफ़्ट दिया गया है
डी&आई बैज की खास जानकारी
परिचय
मकसद
बैज के लेवल
बैज के लिए आवेदन करना
इवेंट बैज के लिए आवेदन करना
इवेंट के लिए पीआर टेंप्लेट
प्रोजेक्ट बैज के लिए आवेदन करना
प्रोजेक्ट के लिए पीआर टेंप्लेट
समीक्षा करना
समीक्षक बनने का तरीका
डी&आई बैज से जुड़ी हितों के टकराव से जुड़ी नीति
समीक्षा की शर्तें
समीक्षा की चेकलिस्ट
भूमिका और ज़िम्मेदारी
आवेदक - पीआर बनाएं
समीक्षक - पीआर की समीक्षा करें
मॉडरेटर - समीक्षाओं और समीक्षा के असाइनमेंट को देखने के लिए
मैनेजर - आखिरी जांच और पीआर मर्ज करना
प्रोबॉट
डी&आई बैज के लिए आचार संहिता
योगदान देने का तरीका
तीसरा डिलीवर किया जाने वाला कॉन्टेंट. दस्तावेज़ों को कई भाषाओं के फ़ॉर्मैट में व्यवस्थित करें और उन्हें Read the docs या Gitbook जैसे प्लैटफ़ॉर्म पर होस्ट करें.
इस मौजूदा वर्कफ़्लो में, ऑटोमेटेड अनुवाद वाले कुछ काम किए जा रहे हैं. मैं यह चेक करने में मदद करूंगा कि अनुवाद का नतीजा, खास तौर पर चीनी भाषा में कितनी अच्छी तरह से परफ़ॉर्म किया गया है. जैसे, अनुवाद कितना सटीक और कितना सटीक है. दस्तावेज़ एक फ़ॉर्मैट के तौर पर मौजूद होगा. मैं Read the docs, Gitbook, और GitHub wiki जैसे तकनीकी दस्तावेज़ों को होस्ट करने वाले प्लैटफ़ॉर्म की जांच करूंगा. साथ ही, समुदाय के लिए उपलब्ध दस्तावेज़ों को होस्ट करने के लिए सबसे सही प्लैटफ़ॉर्म चुनूंगा.