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