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