इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- ब्राज़ीलियन रियाल
- तकनीकी लेखक:
- साहिबकौर
- प्रोजेक्ट का नाम:
- ब्राज़ीलियन रियाल में लेन-देन शुरू करने वालों के लिए गाइड
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
बीआरएल-सीएडी के लिए बिगिनर गाइड
प्रोजेक्ट ऐब्स्ट्रैक्ट
इस प्रोजेक्ट का मकसद उन उपयोगकर्ताओं के लिए दस्तावेज़ बनाना है जो न सिर्फ़ BRL-CAD के लिए नए हों, बल्कि ओपन-सोर्स के लिए भी नए हों.
यह प्रोजेक्ट क्यों
जब मैं पहली बार BRL-CAD वेबसाइट पर गया, तो ओपन-सोर्स और BRL-CAD के लिए नया होने की वजह से मैं एक ही बार में ढेर सारी जानकारी से परेशान हो गई. लेकिन गहराई से, मुझे पता था कि यहां सीखने के लिए बहुत कुछ है. इसलिए, मुझे एक दस्तावेज़ बनाना था, ताकि मेरे जैसे नए उपयोगकर्ताओं को इस कम्यूनिटी से ज़्यादा से ज़्यादा फ़ायदा मिले और वे आसानी से शुरुआत कर पाएं.
लक्ष्य
यह प्रोजेक्ट नए उपयोगकर्ताओं को टारगेट करेगा. इसलिए, यहां कुछ ऐसे पॉइंट दिए गए हैं जिन्हें मेरे दस्तावेज़ में हासिल करना है: यह पक्का करने के लिए कि नए उपयोगकर्ता सहज महसूस करें: यह दस्तावेज़ न सिर्फ़ BRL-CAD के लिए नए उपयोगकर्ताओं के लिए है, बल्कि ओपन-सोर्स के लिए भी नया है.
इसके लिए, मुझे:
- दस्तावेज़ का फ़्लेश-किनकैड स्कोर कम से कम 50 से ज़्यादा रखें. फ़्लेश-किनकेड तरीके के मुताबिक, स्कोर जितना ज़्यादा होगा, उस हिस्से को समझना उतना ही आसान होगा. इसका रीडेबिलिटी स्कोर ऑनलाइन देखा जा सकता है.
- बुलेट वाली या नंबर वाली सूचियों का इस्तेमाल करें, ताकि पाठक लंबे पैराग्राफ़ की वजह से बोर न हों या आपका ध्यान न भटके.
- छोटे पैराग्राफ़ और वाक्यों का इस्तेमाल करें, क्योंकि लंबे वाक्यों को पढ़ने और समझने के लिए, ज़्यादा मानसिक काम करना पड़ता है.
- सबटाइटल का इस्तेमाल करके, टेक्स्ट को अलग-अलग हिस्सों में बांटें. व्यवस्थित दस्तावेज़: अच्छी तरह से तैयार दस्तावेज़, नए उपयोगकर्ताओं को गाइड करने में अहम भूमिका निभाता है. यह उन्हें खोने से बचाता है, और उन्हें यह बताता है कि वे कहां हैं और क्या कर रहे हैं. इसे हासिल करने के लिए, मैंने एक रैंडम मैप तैयार किया है, जिसकी मदद से हम नौसिखियों के लिए गाइड को व्यवस्थित तरीके से दर्ज कर सकते हैं.
प्रोजेक्ट का ब्यौरा
यह प्रोजेक्ट नए उपयोगकर्ताओं के लिए दस्तावेज़ लिखने पर फ़ोकस करता है, ताकि वे इस सॉफ़्टवेयर को इस्तेमाल करना सीख सकें.
नीचे एक उदाहरण दिया गया है, जिसमें बताया गया है कि मुझे किस तरह के दस्तावेज़ को ज़्यादा जानकारी देने वाला बनाना है.
बुनियादी जानकारी: BRL-CAD (कहते हैं be-are-el-cad) एक कंस्ट्रक्टिव सॉलिड ज्यामिति (सीएसजी) सॉलिड मॉडलिंग सॉलिड मॉडलिंग डिज़ाइन (सीएडी) है. यह 3D कंप्यूटर-सहायता डिज़ाइन और ग्राफ़िक विज़ुअलाइज़ेशन के लिए एक शक्तिशाली, क्रॉस-प्लैटफ़ॉर्म, ओपन-सोर्स सॉलिड मॉडलिंग सिस्टम है. क्या आप इस बारे में सोच नहीं सकते? इसके बारे में जानते हैं. ओपन-सोर्स: ओपन सोर्स सॉफ़्टवेयर, सोर्स कोड वाला एक सॉफ़्टवेयर होता है. इसे कोई भी व्यक्ति जांच सकता है, उसमें बदलाव कर सकता है, और उसे बेहतर बना सकता है. BRL-CAD एक ओपन सोर्स सॉफ़्टवेयर होने के नाते होता है, जो BRL-CAD में योगदान देने और पहले से बेहतर बनाने में आपका स्वागत करता है! कंप्यूटर ऐडेड डिज़ाइन (सीएडी): आसान शब्दों में कहें, तो सीएडी कंप्यूटर प्रोग्राम का इस्तेमाल करके, फ़िज़िकल ऑब्जेक्ट को दो या थ्री डाइमेंशन वाले ग्राफ़िकल रूप में दिखाने के लिए इस्तेमाल किया जाता है. ठोस मॉडलिंग प्रणाली: BRL-CAD ठोस मॉडलिंग CAD पर ध्यान देती है. ठोस मॉडलिंग को भौतिक रूप से सटीक होने, 3D स्पेस का पूरी तरह से ब्यौरा देने पर ज़ोर देकर ज्यामितीय मॉडलिंग के अन्य रूपों से अलग किया जाता है. यह किसी ऑब्जेक्ट को अंदरूनी और बाहरी दोनों जगह सिम्युलेट करता है. कंस्ट्रक्टिव सॉलिड जियोमेट्री (सीएसजी): सीएसजी, प्रिमिटिव के बीच बूलियन ऑपरेशन की सीरीज़ के तौर पर कॉम्प्लेक्स मॉडल दिखाने की अनुमति देता है. निरूपण के लिए इस्तेमाल की जाने वाली सबसे सरल ठोस वस्तुओं को प्रिमिटिव कहा जाता है. सीएसजी को बुनियादी स्तर पर समझने के लिए, यहां जाएं.
*जैसा कि प्रोजेक्ट के आइडिया के ब्यौरे में बताया गया है: दस्तावेज़ में बुनियादी इंस्टॉलेशन, क्षमताओं की पूरी जानकारी, BRL-CAD के मॉडलिंग सिद्धांतों का पूरा ब्यौरा, बड़े टूल के बुनियादी इस्तेमाल, मॉडलिंग, इंपोर्ट/एक्सपोर्ट, विश्लेषण, और रेंडरिंग की जानकारी दी जाएगी.
मैं दस्तावेज़ के हर हिस्से को कैसे कवर करूं, इस बारे में कम शब्दों में शुरुआती जानकारी दी गई है.
- सामान्य इंस्टॉलेशन: मैं ज़रूरी स्क्रीनशॉट के साथ BRL-CAD सॉफ़्टवेयर इंस्टॉल करने का सिलसिलेवार ट्यूटोरियल जोड़ूंगा. नए उपयोगकर्ताओं के लिए ट्यूटोरियल एक शानदार जगह है, जहां से वे शुरुआत कर सकते हैं. इनमें से कुछ चीज़ें हैं, जो मुझे नहीं मिल रही हैं:
- इस नए ट्यूटोरियल के चरणों को बुलेट या नंबर नहीं दिया गया है. हर चरण के आखिर में स्क्रीनशॉट के साथ सिलसिलेवार निर्देश होने से, उपयोगकर्ताओं के ट्यूटोरियल की दिलचस्पी बढ़ाने की संभावना बढ़ जाती है.
- सुविधाओं की पूरी जानकारी: इस सेक्शन में वे सभी बातें शामिल होंगी जहां BRL-CAD के पास हैरतअंगेज़ दिखाने की क्षमता होती है. इस हिस्से की तरफ़ ध्यान खींचने के लिए, डायग्राम बनाना एक बेहतर तरीका होगा.
- बीआरएल-सीएडी के मॉडलिंग सिद्धांत: इस हिस्से के बारे में ज़्यादा जानने की ज़रूरत होगी, क्योंकि मॉडलिंग के इन सिद्धांतों को अच्छी तरह से समझने के बाद ही, लोग बीआरएल-सीएडी को बेहतर ढंग से समझ पाएंगे.
- मुख्य टूल का बुनियादी इस्तेमाल: इसके तहत, हमारे पास मुख्य टूल और उनके बुनियादी इस्तेमाल के अलग-अलग ट्यूटोरियल होंगे. यहां सिलसिलेवार ट्यूटोरियल होंगे.
- एक्सपोर्ट/इंपोर्ट: उपयोगकर्ताओं को जियोमेट्री कन्वर्ज़न लाइब्रेरी के बारे में पता चलेगा. ज्यामिति को एक फ़ॉर्मैट से दूसरे फ़ॉर्मैट में बदलना, बीआरएल-सीएडी के सबसे सामान्य इस्तेमाल में से एक है. इस सेक्शन में, हम ग्राहक के तौर पर बदलने और एक्सपोर्ट करने वाले लोगों के बारे में बात करते हैं.
- रेंडरिंग: हम अपने सॉफ़्टवेयर में रेंडरिंग की बुनियादी बातों और इसकी ज़रूरत के बारे में बताएंगे. उपयोगकर्ताओं को यह भी पता चलेगा कि BRL-CAD में इमेज रेंडर कैसे करते हैं.
इसके अलावा, इन बातों पर भी ध्यान दिया जाता है:
- दस्तावेज़ की शुरुआत में ही आपको इस सॉफ़्टवेयर के बारे में बुनियादी जानकारी मिल जाएगी.
- लोग इस ओपन-सोर्स कम्यूनिटी से कैसे जुड़ सकते हैं; इसे BRL-CAD ज़ूलिप चैट का लिंक दें.
- खास जानकारी के लिए, दस्तावेज़ को थोड़ा हंसी-मज़ाक़ वाला बनाएं. साथ ही, नए उपयोगकर्ताओं से कहा जाए कि बड़े-बड़े शब्दों का इस्तेमाल करने से वे निराश न हों. मुझे BRL-CAD विकी के मुख्य पेज में इस्तेमाल किया जाने वाला भावनात्मक दृष्टिकोण पसंद आया.
- इसमें कुछ ऐसी शानदार चीज़ों के स्क्रीनशॉट होंगे जिन्हें लोग इस सॉफ़्टवेयर का इस्तेमाल करके कर सकते हैं.
माइलस्टोन
जुलाई (प्रपोज़ल की समीक्षा की अवधि)
- मौजूदा ट्यूटोरियल देखते समय, मैं खुद को सॉफ़्टवेयर और इसके विकी दस्तावेज़ों से और अच्छे से समझूंगा.
- मैं मौजूदा दस्तावेज़ों में सुधार कर रही हूं.
1 से 7 अगस्त (कम्यूनिटी बॉन्डिंग)
- प्रोजेक्ट के बारे में मेंटॉर से चर्चा करना.
- प्रोजेक्ट की जानकारी बेहतर बनाना.
- माइलस्टोन में ज़रूरी बदलाव करें (अगर ज़रूरी हो).
8 अगस्त - 14 अगस्त
- Docbook एक्सएमएल के बारे में जानना
15 अगस्त - 21 अगस्त
- “बीआरएल-सीएडी के बारे में बुनियादी जानकारी” के लिए दस्तावेज़ लिखना
- “बुनियादी इंस्टॉलेशन” के लिए सिलसिलेवार निर्देश लिखना
22 अगस्त - 27 अगस्त
- ब्राज़ीलियन रियाल में लेन-देन करने की अलग-अलग सुविधाओं के बारे में जानना और स्क्रीनशॉट के साथ उनकी जानकारी देना.
- अलग-अलग सुविधाओं के बारे में अलग पेज पर जानकारी दें.
28 अगस्त से 3 सितंबर
- क्षमताओं के लिए अलग-अलग दस्तावेज़ पर काम जारी रखें.
4 से 10 सितंबर
- मॉडलिंग के सिद्धांतों पर काम करना.
- मॉडलिंग के सभी सिद्धांतों के बारे में जानकारी देना.
11 से 17 सितंबर
- मुख्य टूल के सामान्य इस्तेमाल पर काम करें.
- हर टूल के बुनियादी इस्तेमाल का दस्तावेज़ बनाने के लिए आइडिया को शॉर्टलिस्ट करें.
18 सितंबर से 24 सितंबर
- हर टूल के इस्तेमाल के बारे में जानकारी देना.
25 सितंबर - 1 अक्टूबर
- ट्यूटोरियल के लिए एक अच्छा मॉडल बनाने के लिए मॉडलिंग पर काम करें और उसके साथ एक ड्राफ़्ट लिखें.
2 अक्टूबर से 8 अक्टूबर
- मॉडलिंग ड्राफ़्ट को बेहतर बनाएं.
2 अक्टूबर से 8 अक्टूबर
- एक्सपोर्ट और इंपोर्ट कन्वर्ज़न के बारे में जानकारी.
9 से 15 अक्टूबर
- दस्तावेज़ों को एक्सपोर्ट और इंपोर्ट करें.
- रेंडरिंग पर काम शुरू करें.
16 अक्टूबर से 22 अक्टूबर
- रेंडरिंग ट्यूटोरियल की जानकारी देना.
23 अक्टूबर - 29 अक्टूबर
- सभी दस्तावेज़ों की समीक्षा की जा रही है.
30 अक्टूबर से 5 नवंबर
- Docbook XML पर काम करना
6 से 12 नवंबर
- मेंटॉर और कम्यूनिटी के अन्य सदस्यों से समीक्षाएं मांगें और इन बदलावों पर काम करें.
- मेंटॉर से चर्चा करके और आखिरी बदलाव करना.
12 नवंबर से 22 नवंबर
- चर्चा करने और बदलाव की प्रक्रिया.
- दस्तावेज़ को फ़ाइनल टच दिया जा रहा है.
मेरे बारे में
मैं स्कूल के दिनों से ही लिखने की आदत डाल रही हूं. मैं स्कूल से घर आकर अपने पूरे दिन के बारे में लिखती थी और यह भी लिखती थी कि मेरा दिन किस चीज़ से बेहतर या खराब हुआ. मैं हमेशा अपनी गलतियों को लिखने और उनमें सुधार करने का तरीका जानना चाहता था.
वेब डिज़ाइनर के तौर पर मेरी ट्रेनिंग के दौरान, हमें रोज़ जो कुछ भी सिखाया जाता है उसे लिखने के लिए कहा गया था. मैं उन कुछ समस्याओं और उनके समाधान के बारे में बताऊंगी जिनका मैंने सामना किया.
एक व्यक्ति के रूप में, मैं दूसरों की मदद करने के लिए हमेशा अपनी तरफ़ से कोशिश करती हूं. स्कूल और कॉलेज के दिनों में, मैं उन विषयों को खुद समझ लेने के बाद अपने दोस्तों को भी कुछ विषयों के बारे में समझाता था. GSoD में हिस्सा लेना, एक शानदार कदम है. एक लेखक के तौर पर, मैं दुनिया भर के नए उपयोगकर्ताओं के लिए इस ओपन-सोर्स कम्यूनिटी को ज़्यादा दिलचस्प और मददगार बनाने में योगदान दे सकता हूं.